summaryrefslogtreecommitdiff
path: root/README.md
blob: 11bf820b91c1b8ffaa92694e6d7af1a1a4563286 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# Building

## Dependencies
This project uses the tweaked version of libwren with added timeout support.
You will have to build wren yourself. To do that, you have to clone the wren repo
in this directory with
```
git clone -b limited --depth=1 https://github.com/DegustatorPonos/wren.git
```

Then just build it for your OS. The build system will take care of the rest.
I recommend using zig build system with `build.sh` or `build.bat` in 
`wren/projects/zig` dir

## Windows
For windows you have to clone the dll's in the output lib yourself
You should also download raylib 5.5 manually. 
Put the DLLs in `raylib/lib` and header in `raylib/include/`.

# Development

## Textures convention
All the game colorscheme should contain 6 colors.
The colorscheme is applied at the runtime. Follow the following colorscheme in the assets:
- #FFFFFF - light
- #FF0000 - red
- #00FF00 - green
- #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.