Warning
Some of this repo contains spoilers for SandEEE, read docs outside of the README at your own risk.
SandEEE is a game! 😮
Jokes aside, SandEEE is a programming game meant to be as immersive as possible. Pulling no punches when it comes to design and planning. SandEEE assumes it exists in a world where text is the fundamental data layer, not a byproduct of binary design. Hence consistency, human-readability, and reversibility will always take precedence over performance when it comes to internal systems. When uncertain, programs should prefer formats that read easily when opened as plain text, even if a faster way does exist.
-
Q: why are there so many commits starting with "meta" here
A: TLDR; They are ignored in autogenerated changelogs, and need to be tagged.
This is also why the data file here exists, for When I forget the tag, or have a typo, I can revise a message for just the changelog while preserving git history.
Meta commits all fall into one of the following categories:
- Something that fixes a bug which was not in the last major update
- Something that changes any internal documentation, images, screenshots, or assets.
- Something related to testing/CI.
- Something that is redundant I.E. Something that fixes a bug that I thought I already fixed since the last major update.
Also note these commits are still counted in build version numbers.
-
Q: Can I build and run a non demo build of SandEEE
A: Yes, I wont help you get it working but you run code from this repo even if you don't have the game on itch or steam. The game will be free of course.
-
Q: Should I tell you if I play SandEEE
A: Id love that, but no need if it's too much work.
-
Q: Does this repo contain all of SandEEE's history
A: Unfortunately no. Although most of it is here, there was an initial period of a couple years where the project was just an engine and had no VCS. The first screenshot is here though, and properly dated, so I do know when I first got the project rendering images.
-
Q: Can I help
A: Probably not as of right now. Feel free to PR, but I cant promise I wont just reimplement what you do manually.
- The meta-documentation
- Lore sheet & reference
- Trailer plans (GPT Generated)
- Rolling Bug/Todo List
- Various low pri optimization ideas
- Important asset listing
- Content asset listing
| Path | Purpose |
|---|---|
| assets/ | All the assets for the game, this is stuff out of the builds |
| assets/docs/ | Internal documentation |
| assets/disks/ | Disk image backups |
| assets/steam/ | Steam related images |
| deps/ | Some dependencies, I might not use them all. |
| docs/ | The User facing docs, unprocessed zig build www builds |
| src/ | The Source code |
| fake_steam/ | Files used for the fake Steamworks |
| steam/ | A small custom steam library for zig |
| tests/ | Tests for in game (non zig) code |
| tools/ | Some zig tools for converting file formats and stuffs |
| www/ | A submodule that is hosted on SandEEE website |
| steam_appid.txt | A steam appid file for quick testing, if this is removed I will have to cd into zig-out/bin to run steam builds. |
| VERSION | A file with the current version, used for changelog generation. |
| build.zig build.zig.zon |
SandEEE's build system. |
In early 2024 I was using AI a bit to aid with time planning. In mid-late 2025 for personal reasons I decided to stop this practice, and with that have moved these documents into the repo and clearly labeled all stuff that was in some form AI processed. I do/will not be using these tools in the future, and will not exercise the thought. Any future edits to these documents will be hand written.
All of SandEEE's code, art, and other non audio files are under the MIT License, see the license file for the full text. Any audio files are to be used only within SandEEE.