summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCode-WvS <Code-WvS@users.noreply.github.com>2016-01-24 08:41:03 +0100
committerCode-WvS <Code-WvS@users.noreply.github.com>2016-01-24 08:41:03 +0100
commit477d81446c6db81c703343da58037fe32e862c4e (patch)
tree138e808cf011beb646aab8384c2248cf67165b51
parent69e8d1c05e69695589eec360ec2ab586cc14ae43 (diff)
downloadsnap-byow-477d81446c6db81c703343da58037fe32e862c4e.tar.gz
snap-byow-477d81446c6db81c703343da58037fe32e862c4e.zip
readme: write a short guideHEADgh-pages
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7c878fc..c8bc1b2 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,17 @@
Snap! Build Your Own World
-Like Minecraft in Snap!, just better! Snap-BYOW adds a voxel engine.
+Like Minecraft in Snap!, just better! Snap-BYOW adds a voxel engine. [Try it](http://code-wvs.github.io/snap-byow/snap.html)
+
+Notes:
+ * enter interactive mode in full screen stage mode, let your browser capture the mouse
+ * exit interactive mode by pressing escape twice - once to uncapture the mouse, the second time to exit full stage mode
+ * only `world` and `player` categories are modified
+ * `material 0` is air, 1 is grass, 2 are bricks, 3 is earth
+ * modify the player's view and position through the stage
+ * newly created sprites ("mobs") always span at the same point
+ * skin customization is not possible
+ * cloud saving does not work
+
This project was a weekend project and is not under active development.
Based on [voxel.js](http://voxeljs.com/).