66 lines
1.7 KiB
Markdown
66 lines
1.7 KiB
Markdown
# Shweet's Sim
|
|
|
|
|
|
|
|
Interactive character simulation game.
|
|
|
|
[Resources](https://shweetz.net/files/games/feed-snivy/resources.zip)
|
|
|
|
## Clarification
|
|
This application was developed with the assistance of a large language model.
|
|
|
|
## Build
|
|
|
|
After cloning and entering the repository's directory, make sure to initialize the submodules:
|
|
|
|
```git submodule update --init --recursive```
|
|
|
|
Everything (SDL, Dear ImGui, simdjson, stb_vorbis) is built statically from the submodules. The game's resources are in `resources/` and get linked next to the executable (copied, where links aren't allowed). Release is the default build; add `-DCMAKE_BUILD_TYPE=Debug` to the first command for a debug one.
|
|
|
|
### Linux
|
|
|
|
Needs the X11/Wayland and audio headers SDL builds against.
|
|
|
|
```
|
|
mkdir build
|
|
cd build
|
|
cmake ..
|
|
make
|
|
```
|
|
|
|
### Windows
|
|
|
|
With Visual Studio or MinGW:
|
|
|
|
```
|
|
cmake -B build
|
|
cmake --build build --config Release
|
|
```
|
|
|
|
### Web
|
|
|
|
Needs the [Emscripten SDK](https://emscripten.org/docs/getting_started/downloads.html).
|
|
|
|
```
|
|
emcmake cmake -B build-web
|
|
cmake --build build-web
|
|
```
|
|
|
|
This makes `index.html`, `.js`, `.wasm` and `.data`. Serve all four.
|
|
|
|
## Saves
|
|
|
|
Settings are kept in `settings.txt`, and each character's progress in `saves/<character>.txt`, as plain `key=value` lines. They're in `~/.local/share/shweets-sim` on Linux, `%AppData%/shweets-sim` on Windows, and the browser's storage on the web.
|
|
|
|
## Developer Console
|
|
|
|
Add `console=1` to `settings.txt`, then press the grave key (`` ` ``) in game. `help` lists the commands.
|
|
|
|
## Modding
|
|
|
|
See [MODDING.md](MODDING.md).
|
|
|
|
## License
|
|
|
|
See [LICENSE](LICENSE). The taskbar icons are from [Tabler Icons](https://tabler.io/icons) (MIT), see `resources/common/gfx/ui/LICENSE.txt`.
|