added README, LICENSE, press kit, and logos
This commit is contained in:
parent
10db5d8019
commit
2d95172b15
10
README.md
10
README.md
|
@ -4,22 +4,22 @@ _Cakefoot_ is an ultra-hard, single-button, minimalist avoid 'em up with natural
|
|||
|
||||
![](https://5.shampoo.ooo/video/Cakefoot_the_cookie_crumbles.gif)
|
||||
|
||||
_Cakefoot_ is one of the first games made with the open-source [SPACE🪐BOX](https://open.shampoo.ooo/shampoo/spacebox) engine. It is the first game available for the [💫dank.game](https://dank.game) web games portal. It is a commercial game, but the code is licensed to be open-source and moddable.
|
||||
_Cakefoot_ is one of the first games made with the open-source [SPACE🪐BOX](https://open.shampoo.ooo/shampoo/spacebox) engine. It is the first game available for the [💫dank.game💫](https://dank.game) web games portal. It is a commercial game, but the code is licensed to be open-source and moddable. [Play it free](https://cakefoot.dank.game) online!
|
||||
|
||||
Modding
|
||||
=======
|
||||
|
||||
It is possible to edit or add levels, sprites, and some design parameters without needing to rebuild the game.
|
||||
|
||||
## Config and assets ##
|
||||
### Config and assets ###
|
||||
|
||||
Asset swaps and some style edits, such as colors and fonts, are the easiest mods to do. Change the relevant values in [config.json](config.json). In some cases, the values can even be changed while the game is running just by saving the file changes.
|
||||
|
||||
## Levels ##
|
||||
### Levels ###
|
||||
|
||||
Levels in [resource/levels.json](resource/levels.json) are also easy to add and mod using JSON, but the syntax is not documented yet. The shape of the curve, checkpoints, and enemies are all definable in the level syntax.
|
||||
|
||||
## Code ##
|
||||
### Code ###
|
||||
|
||||
Anything not in the config or the levels file will have to be changed in code, so they will require compiling the code.
|
||||
|
||||
|
@ -57,6 +57,8 @@ Contact
|
|||
|
||||
Feel free to reach out with questions or [raise an issue](https://open.shampoo.ooo/shampoo/cakefoot/issues). Documentation and any other [pull requests](https://open.shampoo.ooo/shampoo/cakefoot/pulls) are welcome.
|
||||
|
||||
| Method | Contact information |
|
||||
| :------ | :----------------------- |
|
||||
| E-mail | cocktail.frank@dank.game |
|
||||
| Web | <https://dank.game> |
|
||||
| X | <https://x.com/diskmem> |
|
||||
|
|
Loading…
Reference in New Issue