Skip to content

Commit

Permalink
📝 adding documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fabienjuif authored Dec 2, 2023
1 parent 2f51d44 commit 367dff1
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,36 @@
# bevy_game_test

> Playing with bevy and testing stuff, do not expect code to be clean and reusable, etc
> Experimenting with Bevy and testing various features. Do not expect the code to be clean and reusable, etc.
## What's the target?

I aim to explore every aspect of building a game with Bevy without having a specific game goal in mind. The features I want to experiment with or include for potential future games are:

- [x] Implement a satisfactory camera (refer to [bevy-cameraman](https://github.com/fabienjuif/bevy_cameraman))
- [x] Integrate physics/collision mechanics
- [ ] Develop responsive player control/kinematics
- [ ] Incorporate particle systems
- [ ] Explore networking capabilities
- [x] Implement a seeded random number generator (RNG)
- [ ] Design basic user interface (UI)
- [ ] Create menus
- [ ] Ensure compatibility across various systems
- [ ] GNU/Linux
- [ ] MacOS (ARM)
- [ ] Windows
- [ ] WebAssembly (Wasm)
- [ ] Android
- [ ] iOS

Upon completing these tasks, the project will be considered finished and can serve as a comprehensive example repository.

## Notes

https://bevy-cheatbook.github.io/input/gamepad.html

windows from linux: https://bevy-cheatbook.github.io/setup/cross/linux-windows.html#microsoft-windows-sdks

## Cross build
### Cross build

⚠️ Does not work from linux to M1 because of a error regarding the compilation of `objc_exception` ([github issue](https://github.com/SSheldon/rust-objc-exception/issues/13))

Expand Down

0 comments on commit 367dff1

Please sign in to comment.