Skip to content

Commit 61ed951

Browse files
authored
Docs: point HANDOFF.md at the port's hard rules and fix stale lines (#120)
HANDOFF.md links PC_PORT_PLAN.md section 1 again; the pointers to the plan were dropped from PC.md and HANDOFF.md in 3e6b4bf and bacee83, which left its hard rules unlinked. Where a rule names specifics that have since changed, PC.md describes the port as built. The README no longer calls the port eventual. PC.md names tools/kazarov/src/cpp, where the shared code lives, instead of tools/kazarov/port. The plan's two "≤" signs, garbled by 50b24b7, are restored. Co-authored-by: carrdylan52 <17089587+carrdylan52@users.noreply.github.com>
1 parent a4408b5 commit 61ed951

4 files changed

Lines changed: 6 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77

88
[<img src="https://decomp.dev/TheMoonPeople/ChronicleTwo/pal.svg?w=512&h=256" width="512" height="256" alt="PAL decompilation progress">][progress_link]
99

10-
Chronicle Two is a decompilation project (and eventual port) of Dark
11-
Chronicle/Dark Cloud 2 for the PlayStation 2.
10+
Chronicle Two is a decompilation of Dark Chronicle/Dark Cloud 2 for the
11+
PlayStation 2, and a native port built from it.
1212

1313
## Building and running
1414

‎docs/PC.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1708,7 +1708,7 @@ The root `CMakeLists.txt` selects the platform: `PS2` builds `ps2/`, and `PC` en
17081708
- `port/src` holds code only the port compiles. `main.cpp` starts the game. `identity.cpp` sets the game's name and directories. `<unit>.cpp` replaces functions of `ps2/src/<unit>.cpp`. `*_asm.cpp` defines the functions `ps2/src` writes in MWCC assembly. `linknames.cpp` supplies link-time names (below). `tests/` holds the GoogleTest cases, one process per case.
17091709
- `port/include` holds `port.h`, included ahead of every unit the port compiles, and `stubs/`, the per-unit headers (below).
17101710
- `port/assets` holds the data the port ships beside the game's: `glyphs/`, the button symbols the build copies to `glyphs/` beside the executable (see [GLYPHS.md](GLYPHS.md)), and `icon/`, the window and package icons.
1711-
- `tools/kazarov` is the shared-code submodule. `tools/kazarov/port` holds the code both games share: `gfx`, `audio`, `platform`, `sce` (the SDK replacements) and `tests`. `cmake/KazarovPort.cmake` gives the port its targets:
1711+
- `tools/kazarov` is the shared-code submodule. `tools/kazarov/src/cpp` holds the code both games share: `gfx`, `audio`, `platform`, `sce` (the SDK replacements) and `tests`. `cmake/KazarovPort.cmake` gives the port its targets:
17121712
- `kz_port_host_library(ct_host)` builds `gfx`, `audio` and `platform`.
17131713
- `kz_port_sce_sources(... LIBS libvu0 libpad libmc sifdev sifrpc eekernel libcdvd libgraph libdma libpkt eekernel_threads libdev libmpeg libsdr modmsin sifdma)` selects the SDK families.
17141714
- `kz_port_tests(darkchronicle_tests)` adds the shared test cases.

‎docs/PC_PORT_PLAN.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -818,7 +818,7 @@ behaviour is implemented; nothing from Chronicle is copied.
818818
`.\build.bat windows-x64` links; `./build.sh ps2-pal` byte-identical;
819819
Chronicle green on any Kazarov commit this WP produced; `git diff --stat
820820
ps2/` listed with justifications in the report.
821-
- Depends: 1.1-1.9. Not parallel. Size: ≤ 1,000, mostly one-liners.
821+
- Depends: 1.1-1.9. Not parallel. Size: ≤ 1,000, mostly one-liners.
822822

823823
**WP1.11 Phase gate and docs [mechanical]**
824824
- Create `docs/PC.md` (build instructions for three OSes, the override
@@ -1420,7 +1420,7 @@ Depends: 2.5. Size: ~600.
14201420
shop, invention, photo), DUNGEON (floors, spheda, ridepod), fishing,
14211421
Gyorace, buggy, menus, saves with scripted input; replace each
14221422
`Ps2Unimplemented` hit from its unit with the pattern of its phase. Each
1423-
round ≤ 1,000 lines, named by the units it covers. Depends: 4.11, 5.4, 6.4.
1423+
round ≤ 1,000 lines, named by the units it covers. Depends: 4.11, 5.4, 6.4.
14241424

14251425
**WP7.5 64-bit audit and crutches [mechanical]** `truncations.md` has no
14261426
unresolved round trip in linked code; PIE; arenas above 4 GiB in tests.

‎docs/port/HANDOFF.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
Read [PC.md](../PC.md) for delivered behavior, build/run instructions and source exceptions. The native port and PS2 build live together; native replacements compile through `PORT_OVERRIDE` and build copies.
44

5+
- The port's hard rules are in [PC_PORT_PLAN.md §1](../PC_PORT_PLAN.md#1-goals-and-hard-rules) and still apply. Where a rule names specifics that have since changed, such as the data layout, converted assets or NTSC timing at 60 Hz, PC.md describes the port as built.
56
- Shared dependency: the renderer, platform, input and mixer in `tools/kazarov`. The repository gitlink is authoritative; `git ls-tree HEAD tools/kazarov` prints its revision.
67
- Supported bounded checkpoints: boot/title, costume selection, opening, Palm Brinks and the first Underground Channel floor. Campaign completion and all sub-games are not established.
78
- Debug defaults off. Config or scene-jump opt-in and controls are described in [DEBUG.md](../DEBUG.md).

0 commit comments

Comments
 (0)