Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DenisD3D committed Apr 16, 2024
1 parent 292b1e0 commit 8be75ad
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@ cmake --build build
- Online high score system computed from apple and bonus eaten
- Full screen support

## Maps

Maps are available directly in the game. They can also be downloaded manually from
the [map repository](https://github.com/DenisD3D/SnakeQT-API/tree/main/maps) and placed in
the `maps` folder. To make a map available for download it must be added to the map repository.
Current most advanced maps are :

- Basic 2
- Island 1

## Map File format

Map are stored as a zip file ending with .skm. The zip file contains the following files:
Expand Down Expand Up @@ -82,6 +92,13 @@ Map are stored as a zip file ending with .skm. The zip file contains the followi
- Support for adaptive textures (choosing the right texture depending on the surrounding tiles) instead of loading all 9
textures as separate ones

## API

The game uses a REST API to download maps and upload high scores. The API is available at https://snakeqt.denisd3d.fr.
To source code is available on [github](https://github.com/DenisD3D/SnakeQT-API) and the documentation directly on
the [dedicated website page](https://snakeqt.denisd3d.fr/docs). HighScore upload is voluntarily hidden from the
documentation to avoid manual upload.

## Tile preprocessing using imageMagick

The tiles texture used in the game come from https://kenney.nl/ assets. Some textures aren't in the right size for the
Expand Down

0 comments on commit 8be75ad

Please sign in to comment.