- Generated by
1.9.8
|
Digimon World 3 decomp
The European version, SLES_039.36
|
The status table is in the README; this page has the details of each part, how the progress is measured, and the workarounds the matched C needs.
.sdata) included, and src/engine/data/ the pieces no module can hold, each file saying why: the matrices nothing in the executable reads (matrices.c), the small data of modules the evidence doesn't name (heap_start.c, get_digimon.c, eu_settings.c, all_files_pattern.c) and the commons the linker laid out (game_bss.c).libpress in STDWTITL, are Sony's code, not the game's: like other PSX decomps, the build takes them from the original as splat's disassembly and the progress leaves them out. The C decompiled of them earlier is in the history.src/shared/ that they include, named with each overlay's prefix (OVL_NAME). STFGTREP has the fader, the fades and the lerps too, and FIGHTSTG the fader's start and drawing.src/field/stages/common/ that the stages include. The stages' data is C too, as splat's words, at the end of each stage's C file. Each stage is in the folder of its area, src/field/stages/<area>/ (see src/field/stages/README.md).Progress is measured by objdiff, with one unit per C file, and tracked on decomp.dev.
After make objdiff, open the repository in the objdiff GUI to see each unit's functions and data against the original. tools/objdiff_generate.py makes one unit per C file (main/system, cnty_sel/cnty_sel, stages/central_sector/wstag200...); a file X_2.c, the second half of one original object, is reported together with X.c. The units go into the category game (the executable), one category per overlay, and stages for all the stages. The executable's data is one unit, main/game_data. The PsyQ libraries get no unit. A file the version being reported doesn't build from C, but has split at the same path (asm/<version>/<binary>/<file>.s), is its unit with no base object, from that code and the module's rodata, data and bss segments, so the report counts all of it as still to do; a binary with no such file is one unit of splat's code and data. The three versions build every file from C today, so none has such a unit. Each version's project is build/<version>/objdiff.json, which make report reads; objdiff.json, which the GUI opens, has the units of every version make objdiff was run for, under the version's name (eu/main/menu/inn, us/main/menu/inn).
Code and data that the build still takes from asm never count as progress: a function behind INCLUDE_ASM keeps splat's .NON_MATCHING label, which objdiff leaves out of the count, and a splat asm or data segment has no C object to match.
objdiff counts a unit's .rodata or .data as matched only when all of the section is the original's, bytes and relocations. The report compares copies of the objects (build/<version>/report/, expected/<version>/report/) made to write the same data the same way: the base gets the target's names for the rodata GCC emits without one (string literals, jump tables), pointers are written as section plus offset on both sides, and the rodata still included from asm (INCLUDE_RODATA, the jump tables of functions behind INCLUDE_ASM) gets one byte changed, so its section only counts once all of it is C. Data that splat still has in its own segments (data in a config rather than .data) isn't in the C object, so it counts as still to do.
The CI (.github/workflows/build.yaml) first runs tools/check_names.py and tools/hacks.py, which only read the source and the configs, and make lint for both versions. It then builds both versions on every push, runs make compare, the shift checks (tools/shiftcheck.py --strict, make padcheck) and make report, checks that the README's status table and docs/binaries.md's overlay table give the report's figures (tools/status_tables.py --check, which writes them), and uploads each build/<version>/report.json as the SLES_039.36_report and SLUS_014.36_report artifacts, which decomp.dev reads; its default version is the European one. The original files come from a private repository, so pull requests from forks only run the first three checks. .github/workflows/docker.yaml builds and compares both versions in the Docker image whenever the image or what it installs changes.
The matched C is meant to read as natural C, but some spots only match through a form that natural C wouldn't take for granted. Each one carries a comment that says so, in one of four standard forms (CONTRIBUTING.md has the rules), and the README's badge counts them: fake matches, then the other kinds together.
| Kind | Count | Marker |
|---|---|---|
| Fake matches | 0 | a comment that starts with /* fake match: and says what is forced and why |
| BEC forms | 1 | a comment that starts with /* BEC form: and names the Digimon World 2 function with the same form |
| Unused frame locals | 4 | /* unused, but it is in the original stack frame */ |
| Form-dependent matches | 162 | a comment that says the match depends on the form |
| Functions still in assembly | 0 | INCLUDE_ASM |
do {} while (0) that ends a CSE block or a variable that exists only to shape the code. There are none so far.-O2) has it. The one so far is STGDGLAB's STGDGLAB_updateSkillPanel, whose skillCount = 6 store is alone in a do { } while (0): its loop notes keep the store before the call's arguments through both schedulers, as Digimon World 2's Stg10_TitleUpdate and Stg20_ShopListUpdate do in theirs. Its comment starts with /* BEC form:.drawTalkBoxArrow, one in STSTATUS's STSTATUS_runStatusChoice, one in FIGHTSTG's func_8008CFFC and three in WFIGHTTS.if without braces, a copy of a variable, a type, or one version's own form of a loop. The hundred and eighty-two so far are a copy of a variable in drawTalkBoxArrow, an unsigned compare in STGMCARD's STGMCARD_updateInfo, a variable that holds two values in STCRDDEK's STCRDDEK_drawDeckCards, a counter set before a call in STCRDDEK_drawEditor, the rows' y offset held in a variable in STCRDDEK_createScreenWindows, a u32 copy of a character in the name entry's keyboard (updateKeyboard, which STCRDDEK, STPLNMET and STDGNAME share), a * 4 written as a statement of its own in FIELDSTG's FIELDSTG_getMapCell, variables local to a case or a block in its FIELDSTG_stretchBannerBox and FIELDSTG_isTileFree, an empty case in its FIELDSTG_updateBanner, two variables for one character and an s16 in its FIELDSTG_runEvent, calls in an if/else and a case 0 next to default in its FIELDSTG_playCutsceneAnim, the button's shift and mask as two statements in its FIELDSTG_controlFlight, a gauge cell read and shifted as two statements in its FIELDSTG_runGauge, an s16 shadow offset in its FIELDSTG_drawActor, a distance written twice in its FIELDSTG_runLaunch, the kind reused for the mode in its FIELDSTG_createActor, a loop with both of its tests at its top and steps added as a choice in its FIELDSTG_runActorAction, the registry held in a variable in its FIELDSTG_findActorAt, a counter for each loop in its FIELDSTG_requestTiles, the start position set with a (Vec2){x, y} constructor in its FIELDSTG_setupField, the leader read into a variable before the trail in its FIELDSTG_drainTrail, the tile move written as an early exit in a do-while (0) with the move declared in it in its FIELDSTG_playBattleTransition, the object's case written as an early exit, a do-while (0) with a break, in its FIELDSTG_controlPlayer (its loop notes weigh the references and stop the schedulers), the file's pick and the frames' step written as early exits in do-while (0)s, a flag read twice, a width cast to s16 and the flag cleared last in its FIELDSTG_animateActor, the map's file check written as an early exit in a do-while (0) with the file declared in it in its FIELDSTG_selectMap, the y offset written as scrollY less its tile's start, x holding the flip before the column and a counter shared by two loops in its FIELDSTG_pickViewTiles, a -1 held in a variable in STGTRAIN's STGTRAIN_updateResult, stats read through two inline functions in its STGTRAIN_runTraining, a variable for each loop and each cursor's last value in its STGTRAIN_runSession, the column set in each branch of an if in its STGTRAIN_raiseResistance, the magic number read into a variable before the image pointer is copied, and the image set before the source moves on, in its STGTRAIN_loadSet, the position pointer set after two calls and a 1 stored as the result in its STGTRAIN_updateActor, stats read as *(totals.stats + i) in its STGTRAIN_showStatChanges, s16 copies of two stats in its STGTRAIN_applyTry, a counter that holds an icon too in its STGTRAIN_drawSession, a frame pointer that holds the animation first in its STGTRAIN_updateSprite, twenty-seven spots in STSTATUS and three in STCRDSHP (a copy, a cast, a temporary, a pointer, a pointer sum, for initializers, a variable of its own for a loop or a case, a counter shared by three loops, a statement written in both branches, a list indexed rather than walked, the order of a sum's terms, a test of another field, two calls in place of a conditional argument or a variable that holds the remainder first), a cards++ written in the for in STCRDSHP's STCRDSHP_createGrid and STCRDSHP_drawCards (which also writes its digits' x as dx + 0x27 + x), four spots in STGDGLAB and four in STITSHOP (loops with counters of their own, a column counter apart from the loop's, a reused variable, range tests written out, a function of its own or a copy), six spots in STFGTREP and twelve in WFIGHTMN (a variable, a case or a statement of its own, a pointer sum, a statement written in both branches, a counter set before a call, a variable reused, a pointer, an offset from a pointer, a while (1) or a helper that stores through pointers), five in WFIGHTTS (the loop around the pad handling in its four lists, a call in each branch in its WFIGHTTS_battleTest, and in its fighter list a counter for each list and the blinking cursor's test split in two, with the fighter's load in both branches), sixty-three spots in FIGHTSTG (cases that do nothing, a case next to default, a menu's result switched with case -1 first, variables declared in an if, a test written the other way round, a value read after a change, a percentage written as * 20 / 100, a table walked by index, an ending written out in each case or branch, a flag cleared in each branch, a step advanced in each case, a row pointer, a variable reused, shared by cases or of its own, a counter set in a loop's init, an index from a later member, a pointer sum, pointers and blocks of their own, a task taken as void *, a value read first, a row's offset added as an int, a value written as a sum and one more, a return in each case, a division written in each branch, a value doubled and scaled in each branch, a counter for each loop, a u8 team, a constant set apart, a goto into a branch, an if/else, an order of stores or of chained stores, a pointer passed on as ++mode, children taken as a void * and copied, a * 32 for a shift, an early exit written as a do-while (0) with breaks as the stages' event code writes it (in the mesh drawer, around each polygon's checks and drawing, where its loop notes weigh the references), a choice written in both branches or a ?:, a pointer to a bone's slot, sums kept in variables so gcc doesn't fold their constants, a primitive tag's word set in two steps, a (Vec2){x, y} constructor, one pointer walking three arrays, a field read through a pointer to the array before it or a vsync callback's s32 argument cast to its task, or a const pointer to the table of battle functions), twelve spots in CARDGAME (a loop or state variable of its own, an empty case, a statement written twice, or a copy of an argument), a reset written in both branches in SHOCKTST's SHOCKTST_playAllPatterns, a times pointer that holds the file's start until the cursors are copied from it and the powers cursor stepped before the times one in its SHOCKTST_convertText, a variable that keeps the old top too in STAGSLCT's STAGSLCT_updateStageSelect and an exit written as a do-while (0) with breaks, with the codes kept in an int as two-byte character constants, in its STAGSLCT_showBiosVersion, the do-while of COUNTDOWN_BORROW, the statement macro of the timed stages' countdown, and the start position that every stage's setup function sets as a (Vec2){x, y} constructor (both in include/field/stage.h).tools/hacks.py --list lists every one with its file, line and function, and also what is assembly without being a hack: the rodata still behind INCLUDE_RODATA and the macros that wrap the inline asm C can't say. The CI fails on what the source must never have: NON_MATCHING code, #if 0 blocks, and inline asm in place of C, top-level data asm included. tools/hacks.py --check README.md docs/status.md checks that the README's badge and the table above are up to date.
1.9.8