mirror of
https://github.com/lisk77/comet.git
synced 2025-10-24 05:48:50 +00:00
update README
This commit is contained in:
parent
80a62ab2b3
commit
328e1075b8
1 changed files with 44 additions and 73 deletions
73
README.md
73
README.md
|
|
@ -4,9 +4,9 @@ a free and open source games framework
|
||||||
> [!WARNING]
|
> [!WARNING]
|
||||||
> This project is in early development and is not yet ready for use.
|
> This project is in early development and is not yet ready for use.
|
||||||
>
|
>
|
||||||
> It could be potentially used to make something very basic in a very hacky way but it is not a good experience
|
> It could be potentially used to make something very basic in a very hacky way, but it is not a good experience
|
||||||
>
|
>
|
||||||
> Installation is manual as of right now but if it reaches an exaptable state I will publish the crate
|
> Installation is manual as of right now but if it reaches an acceptable state I will publish the crate
|
||||||
|
|
||||||
## Recommended setup
|
## Recommended setup
|
||||||
|
|
||||||
|
|
@ -29,7 +29,7 @@ project
|
||||||
# Cargo.toml
|
# Cargo.toml
|
||||||
# ...
|
# ...
|
||||||
[dependencies]
|
[dependencies]
|
||||||
comet = { path = "crates/comet" }
|
comet = { path = "path/of/the/comet/crate" }
|
||||||
# ...
|
# ...
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -57,7 +57,7 @@ fn main() {
|
||||||
.with_icon(r"resources/textures/comet_icon.png") // Sets the window icon
|
.with_icon(r"resources/textures/comet_icon.png") // Sets the window icon
|
||||||
.with_size(1920, 1080) // Sets the window size
|
.with_size(1920, 1080) // Sets the window size
|
||||||
.with_game_state(GameState::new()) // Adds a custom game state struct
|
.with_game_state(GameState::new()) // Adds a custom game state struct
|
||||||
.run::<Renderer2D>(setup, update) // Starts app
|
.run::<Renderer2D>(setup, update) // Starts app with the given
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -89,46 +89,13 @@ fn main() -> Result<()> {
|
||||||
## Todo
|
## Todo
|
||||||
(not ordered by importance)
|
(not ordered by importance)
|
||||||
|
|
||||||
- [x] Fixed update steps (60 updates per second right now)
|
- [ ] (out of the box) Rendering
|
||||||
- [ ] Rendering
|
|
||||||
- [x] 2D
|
|
||||||
- [x] Textures
|
|
||||||
- [ ] 3D
|
|
||||||
- [ ] Meshes
|
|
||||||
- [ ] Normal maps
|
|
||||||
- [x] Texture Atlas
|
|
||||||
- [x] Shaders
|
|
||||||
- [ ] Materials
|
|
||||||
- [ ] Text
|
|
||||||
- [ ] Particles
|
|
||||||
- [ ] Animations
|
|
||||||
- [ ] Lighting
|
|
||||||
- [ ] UI
|
|
||||||
- [ ] Buttons
|
|
||||||
- [ ] Input
|
|
||||||
- [ ] Post-processing
|
|
||||||
- [ ] Multiple render passes
|
|
||||||
- [ ] Individual effects
|
|
||||||
- [ ] Sound
|
|
||||||
- [ ] Input
|
|
||||||
- [ ] Universal input manager
|
|
||||||
- [x] Keyboard
|
|
||||||
- [x] Mouse
|
|
||||||
- [ ] Gamepad
|
|
||||||
- [x] ECS
|
|
||||||
- [x] Components
|
|
||||||
- [x] Entities
|
|
||||||
- [x] Archetypes
|
|
||||||
- [x] World
|
|
||||||
- [ ] Scene
|
|
||||||
- [ ] loading
|
|
||||||
- [ ] saving
|
|
||||||
- [ ] Physics
|
|
||||||
- [ ] 2D
|
- [ ] 2D
|
||||||
|
- [x] texture rendering
|
||||||
|
- [x] world rendering
|
||||||
- [ ] 3D
|
- [ ] 3D
|
||||||
- [x] Plugin System (at least right now)
|
- [ ] Particles
|
||||||
- [x] Adding custom game state struct
|
- [ ] Post-processing
|
||||||
- [x] Adding custom renderer
|
|
||||||
- [ ] Math
|
- [ ] Math
|
||||||
- [x] Vectors
|
- [x] Vectors
|
||||||
- [x] Matrices
|
- [x] Matrices
|
||||||
|
|
@ -137,14 +104,18 @@ fn main() -> Result<()> {
|
||||||
- [ ] Bezier curves
|
- [ ] Bezier curves
|
||||||
- [x] Easing functions
|
- [x] Easing functions
|
||||||
- [ ] Noise
|
- [ ] Noise
|
||||||
- [ ] White
|
|
||||||
- [ ] Perlin
|
|
||||||
- [ ] Simplex
|
|
||||||
- [ ] Worley
|
|
||||||
- [ ] Fractal
|
|
||||||
- [ ] Cellular
|
|
||||||
- [ ] Gradient
|
|
||||||
- [ ] Value
|
|
||||||
- [ ] Cubic
|
|
||||||
- [ ] Ray-casting
|
- [ ] Ray-casting
|
||||||
- [ ] Pathfinding
|
- [ ] Pathfinding
|
||||||
|
- [ ] ECS
|
||||||
|
- [x] Components
|
||||||
|
- [x] Entities
|
||||||
|
- [x] Archetypes
|
||||||
|
- [ ] World
|
||||||
|
- [x] general management
|
||||||
|
- [ ] saving
|
||||||
|
- [ ] loading
|
||||||
|
- [ ] Input
|
||||||
|
- [ ] Sound
|
||||||
|
- [ ] Physics
|
||||||
|
- [x] Basic Plugin System
|
||||||
|
- [x] Custom Renderer
|
||||||
Loading…
Add table
Add a link
Reference in a new issue