See the Install.md : https://github.com/CSEliot/SBoxDevelopmentEnvironment/blob/main/Install.md
A one-stop-shop for S&Box development. Clone it, run a script, start building — whether you're a total beginner in a bootcamp seat or a dev who just wants a sane project layout.
_____ ____
/ ___/ / __ )____ _ __
\__ \______/ __ / __ \| |/_/
___/ /_____/ /_/ / /_/ /> <
/____/ /_____/\____/_/|_|
I teach S&Box — bootcamps and private courses, here in Jordan, starting soon. I also pair with less-technical devs on live projects. Everyone kept hitting the same wall: no clear place to put the engine, the docs, the project, and their notes so that both a human and their local LLM can find things fast.
So: one folder, numbered for terminal navigation, filled with small scripts that mostly do one thing — git clone foobar — plus documentation, research notes, and project templates set up the same way every time.
This is v0.1. It's rough at the edges on purpose — feedback welcome.
This repo does not use and will never contain corpo-AI output, generative "art," or anything that isn't FOSS. Local and free LLMs are fine tools and get used here (they helped port .sh scripts to .bat and organize the 3-Research/ notes) — that's the extent of it. See AGENTS.md.
1-SBox/
├── 0-Builds/ Drop folder for standalone game exports
├── 1-Engine-Builds/ S&Box engine source, three ways
│ ├── Dev/ Community fork (CSEliot & Co.) — built for hacking, still PR-able upstream
│ ├── Steam/ Symlink to your live Steam sbox-editor install
│ └── Vanilla/ Clean Facepunch sbox-public clone, for sanity checks
├── 2-Projects/ Your actual game projects live here (gitignored)
│ └── MySampleProj/ Starter template — organized for humans and local LLMs alike
├── 3-Documentation/ Everything you'd otherwise have thirty tabs open for
│ ├── 1-API/ Scraped per-type API reference, kept updatable via script
│ ├── 2-Docs-Github-Repo/ Local clone of the official sbox.game manual
│ └── 3-Research/ Sandbox quirks & lessons that aren't written down anywhere else
├── 4-SBox-Resources-Subway-Map/ Clone of the community "Subway Map" of external resources
├── 8-Scripts/ Setup & maintenance — every .sh has a Windows .bat twin
├── 9-Archive/ Superseded docs, kept for reference
├── INDEX.md One-line map of the workspace
├── Install.md What you actually need installed
└── ToDo.md What's still rough
Requirements: git, and Python 3.10+ only if you want the API reference generator (3-Documentation/1-API/). Nothing else — no SDKs, no build step. Full details in Install.md.
Then, from 8-Scripts/Linux/ (or 8-Scripts/Windows/), run whichever you need:
| Script | Does |
|---|---|
DownloadFacePunchRepository |
Clones the official Facepunch/sbox-public into 1-Engine-Builds/Vanilla/ |
DownloadCommunityRepository |
Clones the community fork into 1-Engine-Builds/Dev/ and runs its setup |
MakeEngineSteamBuildRef |
Finds your Steam-installed editor and links it as 1-Engine-Builds/Steam/ (safe to re-run) |
DownloadDocumentation |
Clones and updates the API reference + docs mirror into 3-Documentation/ |
DownloadCommunitySubwayMap |
Clones the community resource index into 4-SBox-Resources-Subway-Map/ |
CleanAll |
Wipes cloned/generated content back to a clean slate |
Nothing here runs itself. Pull only what you need.
1-Engine-Builds/Dev/ tracks a fork I maintain that makes building — on Linux and Windows — and modifying the engine less painful, while staying PR-friendly upstream when I want to contribute back. See its own README for build steps.
- Make
INDEX.mdactually human-readable - A build of the engine fork with zero Steam dependency (already mostly possible — the full-featured version needs more work)
- More scripts, more research notes, more templates, as the courses need them
3-Documentation/3-Research/ is the running list of "sandbox quirks" and other things I've learned that aren't documented anywhere official. If you find something worth adding, that's the folder.
Feedback appreciated. Hope you can handle some nuance. 🐫