bevyjam/README.md

# Lux synthesĕ

## Controls

* **Move**: arrows
* **Switch character**: Tab
* **Level up**: Enter (when character is white)
* **Reset**: R

## TODO

* name
* more filters
* despawn black characters
* despawn character when too far
* more levels
* (?) multiplayer
* more audio
* "jumpable" component to avoid jumping on sensors
* bug: in level2, move the blue character to win, then reset. The characters are lighter than expected. (also level 4)
* redshift warning
* itchio test

## Build

```bash
cargo build --release
```

### WASM

**Audio does not work in WASM!**

```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
```

## 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.

## Develop

Skip to level `N: u32` with the command `bevyjam <N>`.

Edit the level `N: u32` with the command `bevyjam <N> e`.

### Editor controls

* **Select**: left click to select, click in void to deselect, CTRL+click to select many, CTRL+A to select all
* **Move selection**: arrows to move one step, Shift+arrows to move continuously
* **Delete selection**: delete
* **Add objects**: P=platform, C=character, A=absorbing filter, R=rotating filter, M=melty platform
* **Move camera**: CTRL+arrows
* **Save**: CTRL+S

## License

GNU AGPL v3, CopyLeft 2022 Pascal Engélibert, Nixon Cheng

_Lux synthesĕ_ 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.  
_Lux synthesĕ_ 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 _Lux synthesĕ_. If not, see https://www.gnu.org/licenses/.
build itchio wasm script 2022-08-27 16:56:54 +00:00			`# Lux synthesĕ`
fix: menu, character despawn 2022-08-21 17:53:08 +00:00
Level management & win 2022-08-23 10:02:58 +00:00			`## Controls`

			`* Move: arrows`
			`* Switch character: Tab`
			`* Level up: Enter (when character is white)`
Reset level 2022-08-25 09:31:12 +00:00			`* Reset: R`
Level management & win 2022-08-23 10:02:58 +00:00
fix: menu, character despawn 2022-08-21 17:53:08 +00:00			`## TODO`

			`* name`
Color filter 2022-08-24 21:11:59 +00:00			`* more filters`
			`* despawn black characters`
			`* despawn character when too far`
editor: add objects 2022-08-26 14:43:10 +00:00			`* more levels`
fix: menu, character despawn 2022-08-21 17:53:08 +00:00			`* (?) multiplayer`
Audio using HexoDSP 2022-08-23 15:02:13 +00:00			`* more audio`
Prevent mid-air jump 2022-08-25 12:47:20 +00:00			`* "jumpable" component to avoid jumping on sensors`
Win text follows camera 2022-08-27 07:08:14 +00:00			`* bug: in level2, move the blue character to win, then reset. The characters are lighter than expected. (also level 4)`
			`* redshift warning`
			`* itchio test`
Initial commit 2022-08-21 17:17:55 +00:00
			`## Build`

			```bash
			`cargo build --release`
			```

			`### WASM`

Fix WASM build 2022-08-24 09:31:17 +00:00			`Audio does not work in WASM!`

Initial commit 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`
			```

Audio using HexoDSP 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.`

Editor: first steps 2022-08-25 22:33:44 +00:00			`## Develop`

			Skip to level `N: u32` with the command `bevyjam <N>`.

			Edit the level `N: u32` with the command `bevyjam <N> e`.

editor: move camera 2022-08-26 08:16:40 +00:00			`### Editor controls`

editor: save 2022-08-26 12:57:53 +00:00			`* Select: left click to select, click in void to deselect, CTRL+click to select many, CTRL+A to select all`
			`* Move selection: arrows to move one step, Shift+arrows to move continuously`
editor: delete 2022-08-26 13:57:32 +00:00			`* Delete selection: delete`
melting platform, level 4 2022-08-26 21:54:49 +00:00			`* Add objects: P=platform, C=character, A=absorbing filter, R=rotating filter, M=melty platform`
editor: move camera 2022-08-26 08:16:40 +00:00			`* Move camera: CTRL+arrows`
editor: save 2022-08-26 12:57:53 +00:00			`* Save: CTRL+S`
editor: move camera 2022-08-26 08:16:40 +00:00
Initial commit 2022-08-21 17:17:55 +00:00			`## License`

add name to copyright 2022-08-24 13:17:09 +00:00			`GNU AGPL v3, CopyLeft 2022 Pascal Engélibert, Nixon Cheng`
Initial commit 2022-08-21 17:17:55 +00:00
build itchio wasm script 2022-08-27 16:56:54 +00:00			`_Lux synthesĕ_ 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.`
			`_Lux synthesĕ_ 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 _Lux synthesĕ_. If not, see https://www.gnu.org/licenses/.`