aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorVaino Kauppila <vaino@vke.fi>2026-07-02 22:58:25 +0300
committerVaino Kauppila <vaino@vke.fi>2026-07-02 23:47:07 +0300
commitcd0c08dc7ce754473178ad3f32f7740a1dddc1eb (patch)
tree589c676b41d6f3d322ea5ce339ddb0811f29ec31 /README.md
downloadforts_clone-cd0c08dc7ce754473178ad3f32f7740a1dddc1eb.tar.gz
forts_clone-cd0c08dc7ce754473178ad3f32f7740a1dddc1eb.zip
Initial import: LibreForts (M0-M5 in progress)
Open-source Forts clone: custom C++20 engine + data-driven (Lua) 2D physics artillery RTS. - Building: node/strut graph on a stiff mass-spring solver (canon Forts model), triangulation rigidity, axial + 30-degree angle-stress breaking, cascading collapse, fire (DoT + spread), ground destroys debris. - Weapons (M4): cannon (ballistic) + laser (beam/ignite) with select-and-aim-in- arc UX; splash / beam damage; bg-brace passthrough. - Devices + economy (M5): reactors + win/loss + restart, mines/turbines/battery, metal deposits, storage caps, per-shot energy cost. - Data-driven via Lua/sol2 with a layered mod loader; enemy-fort scenario mod. - Renderer: SDL3 + textures + ImGui dev UI. stb_image + ImGui vendored. - Assets: CC0 placeholders only; real game art loaded at runtime from the user's own install via forts: paths (bring-your-own; nothing copyrighted committed). See README.md / CLAUDE.md and research/ + requirements/ for detail.
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a164756
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# LibreForts
+
+Open-source clone of Forts, a 2D physics artillery RTS. Custom C++ engine,
+content driven by Lua. Work in progress. See CLAUDE.md for details.
+
+## Stack
+
+C++20, Meson/Ninja (Podman), SDL3, Dear ImGui, a custom mass-spring physics
+solver, Lua 5.4 with sol2, and stb_image.
+
+## Build and run
+
+```sh
+podman build -t forts-clone-dev .
+podman run --rm -v "$PWD":/src:Z --userns=keep-id localhost/forts-clone-dev:latest \
+ sh -c "cd /src && meson setup builddir && meson compile -C builddir"
+./builddir/forts-clone # run from repo root
+```
+
+## Assets
+
+The repo ships CC0 placeholders only. If you own Forts, real textures load at
+runtime from your install via `forts:` paths (set `$FORTS_DATA`). Nothing
+copyrighted is stored here. Forts is copyright EarthWork Games.