Update README.

Filled with informations about the project, build instructions and
keybindings.
This commit is contained in:
KikooDX 2021-03-06 12:54:38 +01:00
parent 1bf3f3c80c
commit ade3423d89
1 changed files with 37 additions and 1 deletions

View File

@ -1,6 +1,42 @@
# Painfull Success CG
A port of my game
[Painfull Success](https://git.sr.ht/painfull-success) for
Casio fx-CG50 calculators.
## Pitch
In this game, you will need to exploit common "failure" mechanics
in platformers. Lava stun you and propulse you high in the opposite
direction you where facing, and going out of bounds allow you to death
warp.
## Controls
* Left and right: move left and right.
* Shift: jump.
* tan and →: move camera up and down.
* 6 (R): restart the level.
* Exit: quit the game.
* Down: fastfall (not needed to complete the game).
## Build
[Builds of this game are available on Planet Casio.](https://www.planet-casio.com/Fr/programmes/programme4134-1-painfull-success-cg-kikoodx-jeux-add-ins.html)
To build this game, you will need:
* A suitable GCC toolchain for SH4 architecture.
* The gint runtime and fxsdk.
You can use [GiteaPC](https://gitea.planet-casio.com/Lephenixnoir/GiteaPC) to setup the toolchain:
```sh
$ giteapc install Lephenixnoir/sh-elf-binutils:any Lephenixnoir/sh-elf-gcc:any Lephenixnoir/fxsdk Lephenixnoir/gint
```
Once it's done, you can build the game using the fxsdk:
```sh
$ git clone https://git.sr.ht/~kikoodx/painfull-success-cg
$ cd painfull-success-cg
$ fxsdk build-cg
```
You can now transfer and run the resulting G3A on your calculator.
## License
The code is under the MIT license.
Levels and colors are under CC-BY-SA.4.0.
Levels and colors are under CC-BY-SA 4.0.
See LICENSE for more details.