Add readme

excaliburjs · Jan 18, 2024 · 8027e2d · 8027e2d
1 parent 9c6aa0e
commit 8027e2d
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 0 deletions.
diff --git a/Excalibur Sample-SpriteFusion.json b/Excalibur Sample-SpriteFusion.json
diff --git a/image.png b/image.png
diff --git a/readme.md b/readme.md
@@ -0,0 +1,24 @@
+# Excalibur SpriteFusion Sample
+
+Play sample [here](https://excaliburjs.com/sample-spritefusion)
+
+Check out [SpriteFusion](https://www.spritefusion.com/editor)! And Export as JSON (`./map/` locally)
+
+Upload the [project](./Excalibur%20Sample-SpriteFusion.json) to SpriteFusion and have fun!
+
+![Sprite Fusion](image.png)
+
+Example running in excalibur
+
+![Sample Running in Excalibur](./sample.gif)
+
+## Running locally
+
+* Using [nodejs](https://nodejs.org/en/) and [npm](https://www.npmjs.com/)
+* Run the `npm install` to install dependencies
+* Run the `npm run start` to run the development server to test out changes
+
+## Building bundles
+
+* Run `npm run start` to produce javascript bundles for debugging in the `dist/` folder
+* Run `npm run build` to produce javascript bundles for production (minified) in the `dist/` folder
diff --git a/sample.gif b/sample.gif