From b8eb2514be47b4d75a3670cff0a22a1719d7fa07 Mon Sep 17 00:00:00 2001 From: kts of kettek Date: Sat, 29 Jan 2022 12:13:03 -0800 Subject: [PATCH] Add README --- Engine/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 Engine/README.md diff --git a/Engine/README.md b/Engine/README.md new file mode 100644 index 0000000..36ffeb1 --- /dev/null +++ b/Engine/README.md @@ -0,0 +1,17 @@ +# GGJ22 Engine +This engine is a Typescript-based engine for GGJ22. It reads files in the yet-to-be-publicly released Vio formats. + +## Installation & Running +Ensure you have node installed, preferably node v16. Download from [here](https://nodejs.org/en/download/). + +After installing, open a terminal or command prompt in this directory and issue the following commands: + +``` +npm i +``` + +``` +npx parcel index.html +``` + +You can now access the game at [http://localhost:1234](http://localhost:1234). \ No newline at end of file