crimsonland 0.1.0.dev12__py3-none-any.whl → 0.1.0.dev14__py3-none-any.whl

crimsonland-0.1.0.dev14.dist-info/METADATA

@@ -0,0 +1,197 @@
+Metadata-Version: 2.3
+Name: crimsonland
+Version: 0.1.0.dev14
+Requires-Dist: construct>=2.10.70
+Requires-Dist: pillow>=12.1.0
+Requires-Dist: platformdirs>=4.5.1
+Requires-Dist: raylib>=5.5.0.4
+Requires-Dist: typer>=0.21.1
+Requires-Python: >=3.13
+Project-URL: Documentation, https://crimson.banteg.xyz/
+Project-URL: Repository, https://github.com/banteg/crimson
+Description-Content-Type: text/markdown
+
+# Crimsonland 1.9.93 decompilation + rewrite
+
+This repository is a **reverse engineering + high‑fidelity reimplementation** of **Crimsonland 1.9.93 (2003)**.
+
+- **Target build:** `v1.9.93` (GOG "Crimsonland Classic") — see [docs/provenance.md](docs/provenance.md) for exact hashes.
+- **Rewrite:** a runnable reference implementation in **Python + raylib** under `src/`.
+- **Analysis:** decompiles, name/type maps, and runtime evidence under `analysis/`.
+- **Docs:** long-form notes and parity tracking under `docs/` (start at [docs/index.md](docs/index.md)).
+
+The north star is **behavioral parity** with the original Windows build: timings, RNG, UI/layout quirks, asset decoding, and gameplay rules should match as closely as practical.
+
+**[Read the full story](https://banteg.xyz/posts/crimsonland/)** of how this project came together: reverse engineering workflow, custom asset formats, AI-assisted decompilation, and game preservation philosophy.
+
+---
+
+## Quick start
+
+Install [uv](https://docs.astral.sh/uv/getting-started/installation/) package manager.
+
+### Run the latest packaged build
+
+If you just want to play the rewrite:
+
+```bash
+uvx crimsonland@latest
+```
+
+### Run from a checkout
+
+```bash
+gh repo clone banteg/crimson
+cd crimson
+uv run crimson
+```
+
+### Keep runtime files local to the repo
+
+By default, runtime files (e.g. `crimson.cfg`, `game.cfg`, highscores, logs, downloaded PAQs) live in your per-user data dir.
+To keep everything under this checkout:
+
+```bash
+export CRIMSON_RUNTIME_DIR="$PWD/artifacts/runtime"
+mkdir -p artifacts/runtime
+uv run crimson
+```
+
+---
+
+## Assets + binaries
+
+There are two separate “inputs” to this repo:
+
+1. **Runtime assets for the rewrite** (PAQ archives)
+2. **Original Windows binaries for reverse engineering** (`crimsonland.exe`, `grim.dll`, …)
+
+We keep them out of git and expect a local layout like:
+
+```text
+game_bins/
+  crimsonland/
+    1.9.93-gog/
+      crimsonland.exe
+      grim.dll
+      crimson.paq
+      music.paq
+      sfx.paq
+artifacts/
+  runtime/        # optional: where you run the rewrite (cfg/status/paqs)
+  assets/         # optional: extracted PAQs for inspection/tools
+```
+
+### Running the rewrite
+
+The rewrite loads the assets from original archives:
+
+- `crimson.paq`
+- `music.paq`
+- `sfx.paq`
+
+### Extracted assets
+
+For inspection/diffs/tools, you can extract PAQs into a filesystem tree:
+
+```bash
+uv run crimson extract crimsonland_1.9.93 artifacts/assets
+```
+
+Same as the original, many loaders can work from either:
+
+- **PAQ-backed assets** (preferred when available), or
+- the **extracted filesystem layout** under `artifacts/assets/`.
+
+---
+
+## CLI cheat sheet
+
+Everything is exposed via the `crimson` CLI (alias: `crimsonland`):
+
+```bash
+uv run crimson               # run the game (default command)
+uv run crimson view ui       # debug views / sandboxes
+uv run crimson quests 1.1    # print quest spawn script
+uv run crimson config        # inspect crimson.cfg
+uv run crimson extract <game_dir> artifacts/assets
+```
+
+Useful flags:
+
+- `--base-dir PATH` / `CRIMSON_RUNTIME_DIR=...` — where saves/config/logs live
+- `--assets-dir PATH` — where `.paq` archives (or extracted assets) are loaded from
+- `--seed N` — deterministic runs for parity testing
+- `--demo` — enable shareware/demo paths
+- `--no-intro` — skip logos/intro music
+
+---
+
+## Docs
+
+Docs are authored in `docs/` and built as a static site at https://crimson.banteg.xyz/
+
+For development, it's useful to have a live local build:
+
+```
+uv tool install zensical
+zensical serve
+```
+
+---
+
+## Development
+
+### Tests
+
+```bash
+uv run pytest
+```
+
+### Lint / checks
+
+```bash
+uv run lint-imports
+uv run python scripts/check_asset_loader_usage.py
+```
+
+### `justfile` shortcuts
+
+If you have `just` installed:
+
+```bash
+just --list
+just test
+just docs-build
+just ghidra-exe
+just ghidra-grim
+```
+
+---
+
+## Reverse engineering workflow
+
+High level:
+
+- **Static analysis is the source of truth.**
+  - Update names/types in [analysis/ghidra/maps/](analysis/ghidra/maps/).
+  - Treat [analysis/ghidra/raw/](analysis/ghidra/raw/) as generated output (regenerate; do not hand-edit).
+- **Runtime tooling** (Frida / WinDbg) validates ambiguous behavior and captures ground truth.
+  - Evidence summaries live under [analysis/frida/](analysis/frida/).
+
+---
+
+## Contributing notes
+
+- Keep changes small and reviewable (one subsystem/feature at a time).
+- Prefer *measured parity* (captures/logs/deterministic tests) over “looks right”.
+- When porting float constants from decompilation, prefer the intended value
+  (e.g. `0.6` instead of `0.6000000238418579` when it’s clearly a float32 artifact).
+
+---
+
+## Legal
+
+This project is an independent reverse engineering and reimplementation effort for preservation, research, and compatibility.
+
+No original assets or binaries are included. Use your own legally obtained copy.

{crimsonland-0.1.0.dev12.dist-info → crimsonland-0.1.0.dev14.dist-info}/RECORD

@@ -1,5 +1,5 @@
 crimson/__init__.py,sha256=dij6OQ6Wctqur9P00ojTTZw6IaUNeZagPX4-2Qqr-Kw,367
-crimson/assets_fetch.py,sha256=z4vFH9h-RIwc2o6uKGzEtUaOdhUDSX6Art-WU6tNjd0,1864
+crimson/assets_fetch.py,sha256=ScrxzSkbs0TkaUtIi-WLC4NN1nIL9J8RloSH_Uz4HGo,2356
 crimson/atlas.py,sha256=hEcCHhPvguXAI6eH_G9Q8rpiX7M5akZ8fgJjMogmYrA,2401
 crimson/audio_router.py,sha256=4lccGu5044WQ5sMz9yfZd4loSgEMDqXJWGvMmHyMGt0,5449
 crimson/bonuses.py,sha256=owwYIRHRu1Kymtt4eEvpd62JwWAg8LOe20vDuPFB5SU,5094
@@ -19,27 +19,30 @@ crimson/effects_atlas.py,sha256=Ko1O7z-1jGkH_KSeb8RrR2EtAs4V8vfo70ofhqbFak4,2104
 crimson/frontend/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
 crimson/frontend/assets.py,sha256=JHxOID6Ti6bD2LercdRJ7sSSr0nRX3WWeuRPDQwwbsY,1343
 crimson/frontend/boot.py,sha256=qZKJba3krNS-SODPAIk7Yl75hCzM0zLlC-Oxuy5ctcM,15334
-crimson/frontend/menu.py,sha256=aA0zpCbuPobtC0fD5FsuZH55HV0HcUhTVVjfqBMlUAA,26179
+crimson/frontend/high_scores_layout.py,sha256=1HaeD8GghlOdmwChrJm_KDHJaepfElmn3lVY4Fvyvm4,793
+crimson/frontend/menu.py,sha256=7s_0Pu9Y09Eh3I3wti8cxqODB--4GXXVh_GrLXtq3SI,26308
 crimson/frontend/panels/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
-crimson/frontend/panels/base.py,sha256=HoZe-HSQcUPHcC1cM9IupTVdo-2yA4xvwBUp05S9LgA,15043
-crimson/frontend/panels/controls.py,sha256=APIf5liMj0jMTTSG3W0bS64lp3IIFhZRbvoSd4W8yTE,4680
+crimson/frontend/panels/base.py,sha256=c0A-vNlsnAxy-jz1cZtO-R2EpVEEL90zfKy6KVRpKcA,14862
+crimson/frontend/panels/controls.py,sha256=Ve-xQ3tmJCzifIEMdqrVhPQ8mm2vNKX8YEV0lYlhr0E,11236
+crimson/frontend/panels/credits.py,sha256=RlOG953MzqNU171MpjaH1tFZ_A4tunh9UT9Gfgpltmc,8429
+crimson/frontend/panels/databases.py,sha256=T5IoAljC-UtJsf_aVc36H9fYa0og2G21qDhJ_783838,11603
 crimson/frontend/panels/mods.py,sha256=Hw6JESTZqHB67KtRSixBtv8YyvTT9sMNW32ecxYJ3rU,4061
-crimson/frontend/panels/options.py,sha256=d9DcmLBylilVrs7wnb-u4p1YdBx6RwDhXggKitiFXjk,15970
-crimson/frontend/panels/play_game.py,sha256=ZWosykIxPWi8ahIzpmg3fth8Zy5Jj-d9iKHK4WaF_nM,24131
-crimson/frontend/panels/stats.py,sha256=cC8-tPNo09QwVk2yoJ4lnFbsqZilIr1UMpJq-jQMzWg,12630
+crimson/frontend/panels/options.py,sha256=v-tEvifvCeb1_tw_sqoQxHrld1rd1gIYQMW1ZA-9Pro,16014
+crimson/frontend/panels/play_game.py,sha256=BiO8oDhb6YQZqs3nZEJqUvajMeC6VRQ577doc50xwSY,24149
+crimson/frontend/panels/stats.py,sha256=1-q9TezFVPADkTmPSAg_c_drkrlMOY3jYHjtAm3XGNE,12573
 crimson/frontend/pause_menu.py,sha256=iM08blMUbgFnV-aGpTHxwieqSQzCnsS66WFMT3lr5vI,16365
 crimson/frontend/transitions.py,sha256=-sAJUDqNZ943zXlqtvJ6jCg2YH8dSi8k7qK8caAfOKI,883
-crimson/game.py,sha256=-1KbJmE4-VN_U4VuHNqqLY9aITBXLXKGAWph8awkJOk,92671
+crimson/game.py,sha256=j8RI1-r67P81wV4_Wy9pKUtqHh8IZTiE-q3yH972z0s,99035
 crimson/game_modes.py,sha256=qW7Tt97lSBmGrt0F17Ni5h8vRyngBzyS9XwWM1TFIEI,255
 crimson/game_world.py,sha256=nfKGcm3LHChPGLHJsurDFAATrHmhRvTmgxcLzUN9m5I,25440
 crimson/gameplay.py,sha256=UHsoxVj6jcdClVLdLM1q1o4NhwSTQqpHSQQ6GBPlT-s,90848
 crimson/input_codes.py,sha256=PmSWFZIit8unTBWk3uwifpHWMuk0qMg1ueKX3MGC7D0,5379
 crimson/modes/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
 crimson/modes/base_gameplay_mode.py,sha256=0hAtdpXLYuhP304qC1GvbQ2rBAALpJTgScDgOs_nRwU,10190
-crimson/modes/quest_mode.py,sha256=Jo4KdJqDdCeV6XGeCa0X9j0qy62YU7K8C0CvTzW9Zl4,38231
+crimson/modes/quest_mode.py,sha256=DUUH5pfACNmFbcT4F0_yhtyuyOZqx-rizKNx_sL3HDE,38322
 crimson/modes/rush_mode.py,sha256=l4TAvjOvOA-Z-liMDXp_HGfszfghTmJUyVSkiPkfHQ0,11527
-crimson/modes/survival_mode.py,sha256=lr165K_byGbWym4eWDfBo6yea1ULc60AxDBKHB-PJPs,33521
-crimson/modes/tutorial_mode.py,sha256=YTUCfpgwrrgzfyRQ0BGcJKx8r825ni9PTQ_RQiV5AnQ,27217
+crimson/modes/survival_mode.py,sha256=ZIPjKf2plu_9CDrJp_WLRIGwUCmDo9_imDqa6h7zLD0,33612
+crimson/modes/tutorial_mode.py,sha256=rWrVSCjM8G-fHn1_0iVWIzGTeLnCFSNktuoRNSX3cg4,27634
 crimson/modes/typo_mode.py,sha256=G3zpg2J7WafXpIYsVV1LeO1gjCCmb40_cbxa_m2kx0U,17957
 crimson/paths.py,sha256=JCKauCxHJnP4IIy5ocgs6tvbaSMkMUByQ76Zoz2UGZM,653
 crimson/perks.py,sha256=JHNhKPOUq2w8h23gU7jpkx-erFKTO4Z8l8aHU8vrkO0,37068
@@ -79,8 +82,9 @@ crimson/ui/cursor.py,sha256=_6EJ7tnsW_Q4kPUrqBO5FInxhpHKUGGyVpDET5EG38I,2842
 crimson/ui/demo_trial_overlay.py,sha256=yrxkpNYanQLaYOofFW01nelKE_bqqYFTunmHSpnbEgA,8818
 crimson/ui/game_over.py,sha256=pkHDGE47yBraHY-BTnZzOFdRGUJ4ravF0cL1HBdA300,30267
 crimson/ui/hud.py,sha256=sVJhh7iAmDISMAcB2AALw1tM0828mlddpAFUXJm8E8c,31123
-crimson/ui/perk_menu.py,sha256=8Litat_Kxax5U23IelaHFQ61faI0QlDnrQsQCzOTN2I,15362
-crimson/ui/quest_results.py,sha256=uQWPcNbE3MumLiIfcJMaWlBmwZ82NA9s8ld-eHfIpCk,28676
+crimson/ui/menu_panel.py,sha256=ko1NErvQ5Ystq4f-AL0_eB6FaWoT_n3uonX-X1Ya_6o,4578
+crimson/ui/perk_menu.py,sha256=Idz7Ps8JzhBqUZQQH-n1dS_DviX5LDWRrhWFO0Qc9Ac,13787
+crimson/ui/quest_results.py,sha256=lbd9uDNyCSNy-KZlNmrCv_S4-JVGioK3DLN65j63PWA,29152
 crimson/ui/shadow.py,sha256=P6B8lZCu8W0YPhLcqi8H413D5oSNeJYwnroYAw4ZGYI,1090
 crimson/views/__init__.py,sha256=1UWCzBSsgIeOtcKxqM4Vf12JEfPHKfb9KRZgl2TB84Q,1880
 crimson/views/aim_debug.py,sha256=2ldQ1MJO8AeG0i9x4ZJ3YLyp1X-HY_nJ0E1mY8jFF7Q,10873
@@ -98,8 +102,8 @@ crimson/views/game_over.py,sha256=R7K7ENM7-ObcsZ5DqPHkrC8fuzAKLOFLZf3j7K5cvDE,40
 crimson/views/ground.py,sha256=_QzsoFSPKA2qIj8OTvJFr2mqT_sM5_w05ucL4a9cCZQ,10226
 crimson/views/lighting_debug.py,sha256=T9ce224ZrJtztKTSFUn1G29MY0KYuHVhNdcDU7hlrFc,45502
 crimson/views/particles.py,sha256=Yp4OfuYAlDa0zB93OZm5gKBNIEeOGJ7kP5mSZ2wZXvc,10109
-crimson/views/perk_menu_debug.py,sha256=q4rn3R4tJASlep5jeAXwrBffj5_akJ4a4veq7FIpRiU,17831
-crimson/views/perks.py,sha256=Uac31DVvHZvjDmMrHpfvkg7LVpXw76xKL1BqwaLAsHU,15052
+crimson/views/perk_menu_debug.py,sha256=aW_1Pvk96FSlxIsMcX8ZUdOGXjY9frqWwdS420_452c,17870
+crimson/views/perks.py,sha256=iravMuB9QzZyrroyciFkTOB5Pnzt4vJz6AjTaOQd3-Y,15091
 crimson/views/player.py,sha256=TYcWqNyat5Sl1kU8cYRdCey5R65UaBJpGoct57Oc6qI,16584
 crimson/views/player_sprite_debug.py,sha256=DDU6kl9sfhZ2nVXzBbsPSUKdIutHf5YNs2DrNQPRb2Q,11158
 crimson/views/projectile_fx.py,sha256=pmMiXm2hJ1XeGf40VtdPk2TbVJX56aATBYTCRekYOdU,23177
@@ -136,7 +140,7 @@ grim/sfx.py,sha256=cpn2Mmeio7BSDgbStSft-eZchO9Ot2MrK6iXJqxlLqU,7836
 grim/sfx_map.py,sha256=FM5iBzKkG30Vtu78SRavVNgXMbGK7ZFcQ8i6lgMlzVw,4697
 grim/terrain_render.py,sha256=EZ7ySYJyTZwXcrJx1mKbY3ewZtPi7Y270XnZgGJyZG8,31509
 grim/view.py,sha256=oF4pHZehBqOxPjKMU28TDg3qATh_amMIRJp-vMQnpn4,334
-crimsonland-0.1.0.dev12.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
-crimsonland-0.1.0.dev12.dist-info/entry_points.txt,sha256=jzzcExxiE9xpt4Iw2nbB1lwTv2Zj4H14WJTIPMkAjoE,77
-crimsonland-0.1.0.dev12.dist-info/METADATA,sha256=_PTDJb4CgDU-60sxdEMFL3VEk0uOpzoKZL6E24hg7mM,244
-crimsonland-0.1.0.dev12.dist-info/RECORD,,
+crimsonland-0.1.0.dev14.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
+crimsonland-0.1.0.dev14.dist-info/entry_points.txt,sha256=jzzcExxiE9xpt4Iw2nbB1lwTv2Zj4H14WJTIPMkAjoE,77
+crimsonland-0.1.0.dev14.dist-info/METADATA,sha256=oXFIziqtI4gQTabCnabSQ9Q9omr3LkcdySpATsnsuqA,5262
+crimsonland-0.1.0.dev14.dist-info/RECORD,,

crimsonland-0.1.0.dev12.dist-info/METADATA

@@ -1,9 +0,0 @@
-Metadata-Version: 2.3
-Name: crimsonland
-Version: 0.1.0.dev12
-Requires-Dist: construct>=2.10.70
-Requires-Dist: pillow>=12.1.0
-Requires-Dist: platformdirs>=4.5.1
-Requires-Dist: raylib>=5.5.0.4
-Requires-Dist: typer>=0.21.1
-Requires-Python: >=3.13