52 lines
1.7 KiB
Markdown
52 lines
1.7 KiB
Markdown
# Pomomon Garden 
|
|
|
|
Pomomon Garden is a Pomodoro game created during ["Sopra" (Softwareprojekt)](https://www.uni-ulm.de/in/sgi/lehre/softwareprojekt-sopra-1/) WiSe 25/26 at the University of Ulm.
|
|
It uses the [ECS](https://en.wikipedia.org/wiki/Entity_component_system)-based Rust game engine called [Bevy](https://bevy.org/).
|
|
|
|
---
|
|
|
|
## About the game
|
|
|
|
The game switches between the focus and pause phase. In the focus phase the player is expected to study/work/... while the timer ticks down.
|
|
After the timer runs out, the player is prompted to switch to the pause phase.
|
|
In this phase he can interact with his farm using Pom, the playable character.
|
|
|
|
---
|
|
|
|
## Build and debug instructions
|
|
|
|
### Building
|
|
|
|
#### Using [Nix Flakes](https://nixos.wiki/wiki/Flakes):
|
|
|
|
```sh
|
|
git clone https://gitlab.uni-ulm.de/softwaregrundprojekt/2025-2026/einzelprojekt/tutorium-moritz/bernroider-dominik/bernroider-dominik pomomon-garden
|
|
cd pomomon-garden
|
|
nix develop
|
|
cargo run
|
|
```
|
|
|
|
#### Other:
|
|
|
|
1. [Install Rust](https://rust-lang.org/tools/install/)
|
|
2. [Install Bevy OS depedencies](https://bevy.org/learn/quick-start/getting-started/setup/#installing-os-dependencies)
|
|
|
|
```sh
|
|
git clone https://gitlab.uni-ulm.de/softwaregrundprojekt/2025-2026/einzelprojekt/tutorium-moritz/bernroider-dominik/bernroider-dominik pomomon-garden
|
|
cd pomomon-garden
|
|
cargo run
|
|
```
|
|
|
|
### Hidden binds (Only available in the debug build)
|
|
|
|
- `Shift + Enter`: Duration of the current phase is set to 3 seconds.
|
|
- `Shift + Left Mouse Button` on Tile: Toggle tile state.
|
|
- `Shift + Arrow Up`: Add one berry to your inventory
|
|
- `Shift + Arrow Down`: Remove one berry from your inventory
|
|
|
|
---
|
|
|
|
## Licensing
|
|
|
|
This project is released under the terms of the [MIT License](LICENSE).
|