Adding modding folder with a hacked build.

2026-09-26 08:53:08 +02:00
parent cdb960dc71
commit c91080aba7
755 changed files with 50424 additions and 0 deletions
@@ -0,0 +1,84 @@
+# Modding
+
+Tools and reference material for modding System Shock (1994) itself - distinct
+from the rest of this repository, which is the [QuestShock](../README.md) VR
+port of the game engine. Everything modding-related lives under this folder.
+
+Both pieces here come from the [InkyBlackness](https://inkyblackness.github.io)
+project and are vendored unmodified, each under its own upstream license (see
+below) - neither is relicensed by this repository's own MIT license.
+
+## Layout
+
+- `hacked/` - [InkyBlackness HackEd](https://github.com/inkyblackness/hacked),
+  the graphical mod editor. A vendored source snapshot (New BSD License),
+  taken from the `main` branch on 2026-09-26. To update it, replace this
+  directory with a fresh checkout and update that date.
+- `ss-specs/` - [InkyBlackness ss-specs](https://github.com/inkyblackness/ss-specs),
+  the unofficial file-format specifications the editor (and any other modding
+  tool) is written against. Reference documentation only, not built. A
+  vendored snapshot (CC BY-NC-SA 4.0 - **non-commercial**, unlike the rest of
+  this repository), taken from the `main` branch on 2026-09-26.
+- `hacked-build-image/` - the Dockerfile (and supporting scripts) for the
+  `hacked` build environment: the Go toolchain plus every dependency
+  `hacked/go.mod` pins, fetched once at image-build time so the actual build
+  needs no network access. Mirrors the main project's own `build-image/`
+  (see the repository root's [README.md](../README.md) section 4) one level
+  down, for this subproject.
+- `hacked-build-image.sh` / `hacked-build-run-image.sh` /
+  `hacked-build-upload-image.sh` - build the image, run it to compile
+  `hacked/`, and push it to a registry, respectively. Same pattern as the
+  root project's own `build-image.sh`/`run-image.sh`/`upload-image.sh`.
+- `Makefile` - `hacked` (default) builds `hacked/` via the image; `build-image`
+  (re)builds the image itself; `clean` removes `dist/`.
+- `dist/` - build output (git-ignored), created by `make hacked`.
+
+Shockolate (the engine `../engine/` vendors) already has its own modding
+support (level/resource files, `res/data/`); this folder is about the
+external tools that create and inspect that content, not about changing the
+engine itself.
+
+## Building `hacked`
+
+Packages `dist/<version>.linux64.tgz` and `dist/<version>.win64.zip` (native
+Linux build, Windows amd64 cross-compiled via mingw-w64 - both from the same
+source, in one run).
+
+**Prerequisites:** Docker - same as the root project, nothing modding-specific
+to install locally.
+
+```sh
+cd modding
+
+# 1. Build the hacked-build-image (once, or after hacked-build-image/ or
+#    hacked/go.mod|go.sum changes)
+./hacked-build-image.sh
+
+# 2. Compile hacked/ for Linux and Windows
+make hacked
+```
+
+`<version>` is `hacked-<date>`, not an InkyBlackness release version:
+`hacked/` is a vendored snapshot here, not its own git checkout, so there is
+no tag to derive a real version from (see
+`hacked-build-image/build-hacked.sh`'s own comment).
+
+Run the result: `dist/linux/hacked/hacked` on Linux,
+`dist\win\hacked\hacked.exe` on Windows. Needs OpenGL 3.2; usage is documented
+on [hacked's own wiki](https://github.com/inkyblackness/hacked/wiki).
+
+### Publishing the build-image
+
+Same registry as the root project's own build-image (see the repository
+root's `registry.env.example`), under a separate image name so the two don't
+collide:
+
+```sh
+./hacked-build-upload-image.sh
+```
+
+Reads `REGISTRY`/`REGISTRY_USER`/`REGISTRY_PASSWORD` and (optionally)
+`HACKED_REGISTRY_IMAGE` from `../registry.env`, same as the root scripts.
+Don't bump `hacked-build-image/VERSION` just because the Dockerfile changed -
+only once a build with the current version has actually succeeded, same
+policy as the root project's own `build-image/VERSION`.