shampoo/cakefoot
shampoo
/
cakefoot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

minor updates to modding and building instructions

This commit is contained in:
ohsqueezy 2024-04-27 22:33:18 -04:00
parent d37f04995c
commit ba53c72b01
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,6 +1,6 @@
![](doc/Cakefoot_logo.png)
_Cakefoot_ is a challenging, single-button dodge 'em up on rails. Pilot a walking cake -- hold to accelerate, let go to drift back, and avoid enemy patterns. Featuring an epic 22-level quest, arcade mode, unlockables, and high scores, _Cakefoot_ is endlessly replayable, and impossible to defeat.
Fork it up! _Cakefoot_ is a challenging, single-button dodge ’em up on rails. Pilot a walking cake – hold to accelerate, let go to drift back – and survive against all odds. Featuring 22 epic levels, arcade mode, unlockables, and high scores, _Cakefoot_ is endlessly replayable, and impossible to defeat.
![](https://5.shampoo.ooo/video/Cakefoot_the_cookie_crumbles.gif)
@ -17,11 +17,11 @@ Asset swaps and some style edits, such as colors and fonts, are the easiest mods
### 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.
Levels in [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 ###
Anything not in the config or the levels file will have to be changed in code, so they will require compiling the code.
Other changes will require code edits. See the [Build](#Build) section.
Build
=====
@ -30,9 +30,11 @@ Clone both the game code and the [SPACE🪐BOX](https://open.shampoo.ooo/shampoo
$ git clone --recursive https://open.shampoo.ooo/shampoo/cakefoot/
Each platform has its own target in the [Makefile](Makefile). There is some documentation in the Makefile itself that should be checked. The current supported platforms are web browsers, Linux, and Windows. Until further documentation is added, the best way to get started on building for a platform is by installing the prerequisites for SPACE🪐BOX, compiling the [box demo](https://open.shampoo.ooo/shampoo/spacebox/src/branch/main/demo/box) for the desired platform, and attempting to build a _Cakefoot_ target.
Each platform has a corresponding target in the [Makefile](Makefile). There is some documentation in the Makefile itself that should be checked. The current supported platforms are web browsers, Linux, Windows, and MacOS.
To build on Linux, for example, once SPACE🪐BOX is confirmed to be working, run
Until further documentation is added, one way to get started building for a platform is to first build the [box demo](https://open.shampoo.ooo/shampoo/spacebox/src/branch/main/demo/box) for the desired platform in a separate project.
Once the box demo is confirmed to build, try making a build of Cakefoot, for example the Linux version
$ make Cakefoot-linux_debug.x86_64