summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index fca07cf..11bf820 100644
--- a/README.md
+++ b/README.md
@@ -28,3 +28,19 @@ The colorscheme is applied at the runtime. Follow the following colorscheme in t
- #FF7F00 - accent light
- #0000FF - accent dark
- #000000 - dark
+
+## Puzzle location
+The puzzles are stored in so called collections. The collection is basically
+a directory that contains other directories and .pz (puzzle) files.
+The collection can have an icon that will be displayed on the bottom of each of its elements.
+They are intended to be semi-transparent.
+To use it put `icon.png` in the root of the directory.
+
+The naming of the file is as follows:
+`<order>.<name>.pz`
+The order is optional but is advised to sort the puzzles in the game. Order field
+can contain dots, only last or second to last parts will be used as a name.
+Only the name part will be applied.
+
+It is not recommended to nest the puzzles deeper than 3 layers because it might cause
+some funky glithes in the scene stack logic.