Skip to content

Commit

Permalink
Update gui readme
Browse files Browse the repository at this point in the history
  • Loading branch information
maddymakesgames committed Mar 22, 2024
1 parent 1a4afe5 commit c5da2f1
Showing 1 changed file with 5 additions and 13 deletions.
18 changes: 5 additions & 13 deletions gui/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,8 @@
# celeste_rs gui
You can find a web version of the gui editor [here](https://maddymakesgames.github.io/celeste_rs/).<br>

## Design
We separate the app into 3 states, though in reality only 1 of them really matters.<br>
We have the `Startup` state, which just transitions immediately into the `MainMenu` state.<br>
The `MainMenu` state displays a button to request a save file, and handles reading in the save file and then transitions to the `Editor` state.<br>
The editor state is internally separated into different sections with each section having its own render method.
## Rational
This app uses the [egui](https://github.com/emilk/egui) gui library. This is mainly due to it being something I've used before and intermediate mode being quite good for what is essentially just editing a bunch of fields on a struct. This does mean our web app is not the best. Personally I prefer native applications hence why I am okay with this, but I do understand others may perfer a web app. This was the main reason I separated the reading / writing of save files and the gui logic into two separate crates, someone looking to make a more proper web app can just include the `celeste_rs` library and use that for the i/o logic.

## TODO
- [x] Strawberry addition / deletion
- [x] Proper error messages
- [x] Session editing
- [ ] Some `modsave` or `modsession` editing for popular mods
## Planned Features
- [ ] Editing multiple files without restarting the app
- [ ] Importing `*-modsavedata.celeste` to load stored modded stats
- [ ] Importing session data saved with [Aurora's Additions](https://gamebanana.com/mods/422271)
- [ ] Editing colors and fonts

0 comments on commit c5da2f1

Please sign in to comment.