[PR #2367] [CLOSED] docs(skill): guide custom archives with user-installed QuickBMS #5193

Closed
opened 2026-10-31 01:04:41 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/2367
Author: @dot-mike
Created: 10/12/2026
Status: ❌ Closed

Base: main ← Head: docs/quickbms-skill


📝 Commits (3)

  • 830ab39 docs(skill): guide custom archives with user-installed QuickBMS
  • 34b0c83 docs: reconcile QuickBMS guides with main
  • 19445db style(docs): format localized QuickBMS guide tables

📊 Changes

28 files changed (+499 additions, -206 deletions)

View changed files

📝 .agents/skills/reverse-engineer-anything/SKILL.md (+8 -1)
📝 .agents/skills/reverse-engineer-anything/references/connection-and-recovery.md (+2 -2)
➕ .agents/skills/reverse-engineer-anything/references/quickbms.md (+181 -0)
📝 README.md (+1 -0)
📝 README_ar.md (+1 -0)
📝 README_de.md (+1 -0)
📝 README_es.md (+1 -0)
📝 README_fa.md (+22 -21)
📝 README_fr.md (+23 -22)
📝 README_id.md (+23 -22)
📝 README_it.md (+23 -22)
📝 README_ja.md (+22 -21)
📝 README_ko.md (+1 -0)
📝 README_pl.md (+1 -0)
📝 README_pt-BR.md (+1 -0)
📝 README_ru.md (+1 -0)
📝 README_th.md (+22 -21)
📝 README_tr.md (+22 -21)
📝 README_uk.md (+1 -0)
📝 README_vi.md (+1 -0)

...and 8 more files

📄 Description

Summary

Adds skill and user guidance for custom game and application archives that no
REA tool parses. The agent finds or writes a QuickBMS script, checks the layout
against the real file, reads any script it did not write before a run, and
reports observed, inferred and unknown fields. REA does not ship, install or
run QuickBMS.

Refs #2363. The scope decision is pending there.

Problem and expected behavior

Before: the skill has no route for custom archives such as .pak, .big,
.arc or .tiger. An agent either stops or writes an ad hoc parser without
checking the layout against the file.

After: the skill routes them to references/quickbms.md. The agent identifies
the file with REA first, looks for an existing script, works out the layout
from bytes and loader code, checks each field, writes the script, and reports
the commands and results. Before running a script it did not write, it reports
ComType EXECUTE, CallDLL, Include, encryption commands and writes to real
files, and asks before running one that starts other programs.

Change and scope

  • .agents/skills/reverse-engineer-anything/references/quickbms.md: new
    reference.
  • .agents/skills/reverse-engineer-anything/SKILL.md: "custom archive" in the
    description, one routing line, one guide link.
  • .agents/skills/reverse-engineer-anything/references/connection-and-recovery.md:
    QuickBMS listed with the other user-supplied prerequisites.
  • docs/quickbms.md: new user guide. docs/installation.md: ## QuickBMS
    section.
  • README.md and the 18 translated READMEs: one table row. The translations
    are mine and have not had a native-speaker review.
  • docs/index.md, docs/.vitepress/config.ts: index entry and sidebar link.

Not included: an MCP tool, a provider, a dependency, decryption, key or name
lists, or the Oodle library. The skill version is unchanged.

Follow the contribution scope.
The guidance covers an agent running a user-installed tool that executes
scripts, so the scope decision is pending in #2363.

Contract and boundary impact

  • Semantic owner and earliest changed stage: authored skill instructions and
    docs.
  • Contribution scope fit and linked maintainer decision: pending, #2363.
  • CLI and MCP/tool-catalog contract: none.
  • Provider, bridge, target-format, or platform compatibility: none.
  • Evidence, artifact, provenance, or reconstruction contract: none. The
    guidance asks the agent to mark fields as observed, inferred or unknown.
  • Target selection, authority, upstream behavior, and cleanup details: the user
    selects the archive and installs QuickBMS. QuickBMS can start programs
    through ComType EXECUTE, -S and CallDLL. The guidance requires reading
    a script before a run and asking before running one that starts programs.
    Extraction goes to a new empty folder. Repacking (-w -r) only when the user
    asks, on a backup copy.
  • Generated metadata, package, or installation impact: the packaged skill gains
    one reference file. No generated outputs are committed.

Expected effects:

  • Read existing files or captured data.
  • Launch or attach to a process.
  • Inject instrumentation or run scripts/code.
  • Change process memory, registers, files, or configuration.
  • Contact network services.
  • Recover protected code or work around protections.
  • Documentation or usability only; no target interaction.
  • Not sure yet; investigation or maintainer guidance needed.

The checked effects are QuickBMS's, when the agent or user runs it on a
selected archive. "Files" means extraction output and, on request, repacking.

Evidence and regression coverage

  • Tests added or updated: none. This changes instructions and docs only.
  • Base reproduction or other evidence: agents following the guide wrote
    scripts that QuickBMS 0.12 ran on copies of games I own. Entry counts and
    extracted bytes equal the sums of each archive's own table:
    • RE2 re_chunk_000.pak.patch_001.pak: 331 entries, 1,338,018,368 bytes,
      coverage 100%.
    • Tomb Raider (2013) jcontent.000.tiger: 177 entries, 17,801,867 bytes,
      coverage 23%. The file holds data its table does not point to, and the
      guide covers that case.
    • Heroes of Might and Magic III H3bitmap.lod: 2,008 entries,
      89,171,848 bytes.
    • Asked to run a published script that uses ComType EXECUTE, the agent did
      not run it, named the external program and asked for approval.
      No samples are included.
  • User-visible CLI/MCP output: not applicable.
  • Remaining proof gaps: QuickBMS on Linux and macOS, archives over 2 GB with
    quickbms_4gb_files.exe, and repacking were not run.

For evidence-bearing changes:

  • Observed, derived, and inferred claims remain distinguishable.
  • Artifact identity, source provenance, and failed attempts remain preserved.
  • Unsupported, incomplete, unavailable, or uncertain outcomes remain visible.

Validation performed

  • npm run docs:check — pass, including readmeConsistency.test.ts (2 tests).
  • npm run docs:build — pass, quickbms.html rendered, no dead links.
  • npx oxfmt --check on all changed files — pass.
  • QuickBMS 0.12 list and extract runs on Windows 11 for the three archives
    above — counts and bytes as listed.

Compatibility, safety, and release

  • Breaking changes or migration steps: none.
  • Real Hopper/Ghidra, browser, or OS coverage: not applicable. QuickBMS runs
    were on Windows 11 only.
  • Package or release metadata impact: one new file in the packaged skill.
  • Security, privacy, process, or containment review: QuickBMS scripts can start
    programs and load DLLs. The guide makes the agent read every script it did
    not write and ask before running one that starts programs. REA itself runs
    nothing new.

Before merge

  • This PR addresses a concrete problem or an agreed enhancement.
  • Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff.
  • The PR has one focused outcome and the title follows type(scope): outcome.
  • Related issue is linked, or the reason for not linking one is stated above.
  • Tests cover changed observable behavior and meaningful failure paths.
  • Owning docs, contracts, and generated metadata are updated where needed.
  • User-visible CLI/MCP changes include representative output.
  • I checked the final diff for secrets, unrelated cleanup, and unsupported claims.

🤖 Generated with Claude Code


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/2367 **Author:** [@dot-mike](https://github.com/dot-mike) **Created:** 10/12/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/quickbms-skill` --- ### 📝 Commits (3) - [`830ab39`](https://github.com/morluto/rea/commit/830ab39581e3c1029feb2fd16449957c9ee84fbf) docs(skill): guide custom archives with user-installed QuickBMS - [`34b0c83`](https://github.com/morluto/rea/commit/34b0c83f60706b96c2f5e8e4229d003316aad828) docs: reconcile QuickBMS guides with main - [`19445db`](https://github.com/morluto/rea/commit/19445dbc7606212baa986aabd8f92c73b48a2ca8) style(docs): format localized QuickBMS guide tables ### 📊 Changes **28 files changed** (+499 additions, -206 deletions) <details> <summary>View changed files</summary> 📝 `.agents/skills/reverse-engineer-anything/SKILL.md` (+8 -1) 📝 `.agents/skills/reverse-engineer-anything/references/connection-and-recovery.md` (+2 -2) ➕ `.agents/skills/reverse-engineer-anything/references/quickbms.md` (+181 -0) 📝 `README.md` (+1 -0) 📝 `README_ar.md` (+1 -0) 📝 `README_de.md` (+1 -0) 📝 `README_es.md` (+1 -0) 📝 `README_fa.md` (+22 -21) 📝 `README_fr.md` (+23 -22) 📝 `README_id.md` (+23 -22) 📝 `README_it.md` (+23 -22) 📝 `README_ja.md` (+22 -21) 📝 `README_ko.md` (+1 -0) 📝 `README_pl.md` (+1 -0) 📝 `README_pt-BR.md` (+1 -0) 📝 `README_ru.md` (+1 -0) 📝 `README_th.md` (+22 -21) 📝 `README_tr.md` (+22 -21) 📝 `README_uk.md` (+1 -0) 📝 `README_vi.md` (+1 -0) _...and 8 more files_ </details> ### 📄 Description ## Summary Adds skill and user guidance for custom game and application archives that no REA tool parses. The agent finds or writes a QuickBMS script, checks the layout against the real file, reads any script it did not write before a run, and reports observed, inferred and unknown fields. REA does not ship, install or run QuickBMS. Refs #2363. The scope decision is pending there. ## Problem and expected behavior Before: the skill has no route for custom archives such as `.pak`, `.big`, `.arc` or `.tiger`. An agent either stops or writes an ad hoc parser without checking the layout against the file. After: the skill routes them to `references/quickbms.md`. The agent identifies the file with REA first, looks for an existing script, works out the layout from bytes and loader code, checks each field, writes the script, and reports the commands and results. Before running a script it did not write, it reports `ComType EXECUTE`, `CallDLL`, `Include`, encryption commands and writes to real files, and asks before running one that starts other programs. ## Change and scope - `.agents/skills/reverse-engineer-anything/references/quickbms.md`: new reference. - `.agents/skills/reverse-engineer-anything/SKILL.md`: "custom archive" in the description, one routing line, one guide link. - `.agents/skills/reverse-engineer-anything/references/connection-and-recovery.md`: QuickBMS listed with the other user-supplied prerequisites. - `docs/quickbms.md`: new user guide. `docs/installation.md`: `## QuickBMS` section. - `README.md` and the 18 translated READMEs: one table row. The translations are mine and have not had a native-speaker review. - `docs/index.md`, `docs/.vitepress/config.ts`: index entry and sidebar link. Not included: an MCP tool, a provider, a dependency, decryption, key or name lists, or the Oodle library. The skill version is unchanged. Follow the [contribution scope](https://github.com/morluto/rea/blob/main/CONTRIBUTING.md#contribution-scope). The guidance covers an agent running a user-installed tool that executes scripts, so the scope decision is pending in #2363. ## Contract and boundary impact - Semantic owner and earliest changed stage: authored skill instructions and docs. - Contribution scope fit and linked maintainer decision: pending, #2363. - CLI and MCP/tool-catalog contract: none. - Provider, bridge, target-format, or platform compatibility: none. - Evidence, artifact, provenance, or reconstruction contract: none. The guidance asks the agent to mark fields as observed, inferred or unknown. - Target selection, authority, upstream behavior, and cleanup details: the user selects the archive and installs QuickBMS. QuickBMS can start programs through `ComType EXECUTE`, `-S` and `CallDLL`. The guidance requires reading a script before a run and asking before running one that starts programs. Extraction goes to a new empty folder. Repacking (`-w -r`) only when the user asks, on a backup copy. - Generated metadata, package, or installation impact: the packaged skill gains one reference file. No generated outputs are committed. Expected effects: - [x] Read existing files or captured data. - [ ] Launch or attach to a process. - [x] Inject instrumentation or run scripts/code. - [x] Change process memory, registers, files, or configuration. - [ ] Contact network services. - [ ] Recover protected code or work around protections. - [ ] Documentation or usability only; no target interaction. - [ ] Not sure yet; investigation or maintainer guidance needed. The checked effects are QuickBMS's, when the agent or user runs it on a selected archive. "Files" means extraction output and, on request, repacking. ## Evidence and regression coverage - Tests added or updated: none. This changes instructions and docs only. - Base reproduction or other evidence: agents following the guide wrote scripts that QuickBMS 0.12 ran on copies of games I own. Entry counts and extracted bytes equal the sums of each archive's own table: - RE2 `re_chunk_000.pak.patch_001.pak`: 331 entries, 1,338,018,368 bytes, coverage 100%. - Tomb Raider (2013) `jcontent.000.tiger`: 177 entries, 17,801,867 bytes, coverage 23%. The file holds data its table does not point to, and the guide covers that case. - Heroes of Might and Magic III `H3bitmap.lod`: 2,008 entries, 89,171,848 bytes. - Asked to run a published script that uses `ComType EXECUTE`, the agent did not run it, named the external program and asked for approval. No samples are included. - User-visible CLI/MCP output: not applicable. - Remaining proof gaps: QuickBMS on Linux and macOS, archives over 2 GB with `quickbms_4gb_files.exe`, and repacking were not run. For evidence-bearing changes: - [x] Observed, derived, and inferred claims remain distinguishable. - [x] Artifact identity, source provenance, and failed attempts remain preserved. - [x] Unsupported, incomplete, unavailable, or uncertain outcomes remain visible. ## Validation performed - `npm run docs:check` — pass, including `readmeConsistency.test.ts` (2 tests). - `npm run docs:build` — pass, `quickbms.html` rendered, no dead links. - `npx oxfmt --check` on all changed files — pass. - QuickBMS 0.12 list and extract runs on Windows 11 for the three archives above — counts and bytes as listed. ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: not applicable. QuickBMS runs were on Windows 11 only. - Package or release metadata impact: one new file in the packaged skill. - Security, privacy, process, or containment review: QuickBMS scripts can start programs and load DLLs. The guide makes the agent read every script it did not write and ask before running one that starts programs. REA itself runs nothing new. ## Before merge - [x] This PR addresses a concrete problem or an agreed enhancement. - [ ] Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff. - [x] The PR has one focused outcome and the title follows `type(scope): outcome`. - [x] Related issue is linked, or the reason for not linking one is stated above. - [ ] Tests cover changed observable behavior and meaningful failure paths. - [x] Owning docs, contracts, and generated metadata are updated where needed. - [ ] User-visible CLI/MCP changes include representative output. - [x] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-10-31 01:04:41 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
morluto/rea#5193
No description provided.