templates/platform/readme.txt in entityjs-0.3.1 vs templates/platform/readme.txt in entityjs-0.3.2
- old
+ new
@@ -7,38 +7,37 @@
## /assets
Contains all sounds, images and data files. Place all sounds in the sounds directory
and all the images in the images directory. These directories will be looked at
and an asset array will be created for easy asset loading (see scripts/scenes/load.js)
-Creating any other directory or placing files in the levels directory will be seen
-as data files and will be read and automatically put in js files.
+## /builds
-For example, if I have a directory like /assets/animations/monster.json.
+Contains assets and minified code for the game.
-The file will automatically be read upon calling 'entityjs refresh' and will be turned into this:
+## /scripts
-re.e('monster.json animation')
-.attr(**Animation JSON here**);
+Contains javascripts and coffeescripts for the game.
-Which means you can edit files in different programs and not worry about copying and pasting
-the contents. Just run entityjs refresh.
-At the moment only JSON is supported but in the future, XML, YAML, CSV and TMX will be supported.
-TMX is a special XML format for a tile map editor.
+Data files such as xml, json or tmx will be read and automatically compiled into js files.
-## /builds
+For example, if I have a directory like /scripts/animations/monster.json.
-Contains assets and minified code for the game.
+The file will be turned into this:
-## /scripts
+re.e('monster.json animation')
+.attr(**Animation JSON here**);
-Contains javascripts for the game.
+Which means you can edit files in different programs and not worry about copying and pasting
+the contents.
+TMX is a special XML format for a tile map editor.
+
## /tests
Contains tests for the game. It is good practice to keep this structured exactly the same as the scripts
-directory.
+directory. Tests can also be in coffeescript.
## /tmp
Contains temporary files generated by EntityJS Gem. Usually don't have to touch this.
Might be removed and replaced in the future.
@@ -82,6 +81,6 @@
## refresh sources
entityjs refresh
or
entityjs r
-Creates a file called game.debug.js inside /tmp
\ No newline at end of file
+Creates a file called game.debug.js inside /tmp