bevyjam/README.md

54 lines
1.4 KiB
Markdown
Raw Normal View History

2022-08-21 17:53:08 +00:00
# Bevyjam
2022-08-23 10:02:58 +00:00
## Controls
* **Move**: arrows
* **Switch character**: Tab
* **Level up**: Enter (when character is white)
2022-08-21 17:53:08 +00:00
## TODO
* name
2022-08-24 21:11:59 +00:00
* more filters
* despawn black characters
* despawn character when too far
2022-08-21 17:53:08 +00:00
* level design
* (?) can jump only from a surface (no mid-air jump)
* (?) multiplayer
2022-08-23 10:02:58 +00:00
* level reset
2022-08-23 15:02:13 +00:00
* more audio
2022-08-21 17:17:55 +00:00
## Build
```bash
cargo build --release
```
### WASM
2022-08-24 09:31:17 +00:00
**Audio does not work in WASM!**
2022-08-21 17:17:55 +00:00
```bash
rustup target add wasm32-unknown-unknown
cargo install wasm-bindgen-cli
sh build-wasm.sh
# Serve on 127.0.0.1:8000
python3 -m http.server
```
2022-08-23 15:02:13 +00:00
## Audio
This game uses [HexoDSP](https://github.com/WeirdConstructor/HexoDSP) for audio synthesis.
The synthetizer matrix can be edited using [HexoSynth](https://github.com/WeirdConstructor/HexoSynth) visual editor.
2022-08-21 17:17:55 +00:00
## License
2022-08-24 13:17:09 +00:00
GNU AGPL v3, CopyLeft 2022 Pascal Engélibert, Nixon Cheng
2022-08-21 17:17:55 +00:00
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.