Commonwealth-Online/Commonwealth-Online-Public
3
0
Fork 0
Code Pull Requests Activity

Update README.md

Browse Source
This commit is contained in:
andrew
2026-07-10 21:50:52 +12:00
parent 1ea4131196
commit 52212ef7b1
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -5
View File
@@ -169,15 +169,15 @@ Root batch scripts: `build-all.bat`, `deploy-all.bat`, `build.bat`, `compile-pap
## AI use statement ## AI use statement
This project uses AI-assisted coding tools (for example Cursor, ChatGPT, or Copilot) as a **learning aid** and as a **helper for everyday development** — drafting boilerplate, exploring APIs, debugging networking and UI code, and iterating on features such as proxy appearance sync, server tooling, and getting weapon models to display on remote players. This project uses AI-assisted development tools, including Cursor, ChatGPT, and GitHub Copilot, as learning aids and everyday development tools. They may be used to draft boilerplate, explore APIs, investigate errors, review code, and assist with features such as networking, UI development, proxy appearance synchronisation, server tooling, and remote weapon display.
AI is also used for **tedious but important housekeeping** — turning rough session notes into properly formatted [`changelog.md`](changelog.md) entries, [`docs/dev-log.md`](docs/dev-log.md) milestone write-ups, and detailed commit messages. The maintainer still decides what changed and what matters; AI mainly helps phrase, structure, and keep that record consistent with project conventions (for example Keep a Changelog categories and the dev-log milestone format). AI is also used for routine project maintenance, such as turning development notes into structured [`changelog.md`](changelog.md) entries, [`docs/dev-log.md`](docs/dev-log.md) milestones, and detailed commit messages. The maintainer determines what changed, what is significant, and what should be recorded. AI primarily helps organise and phrase that information consistently with the repository's conventions.
**AI is not a substitute for Fallout 4 engine expertise or community knowledge.** A clear example is animation sync: for roughly a week, AI-assisted attempts to drive locomotion and weapon-drawn animations on proxy actors produced plausible variable names and events that **do not exist on the real animation graphs** and failed silently at runtime. That is not how regular Bethesda animation graphs work — you cannot guess your way to the correct `hkx` behavior internals from general game-modding patterns alone. AI output is not treated as authoritative, particularly when working with undocumented Fallout 4 engine behaviour. For example, early AI-assisted animation-sync experiments produced plausible animation variable and event names that did not exist in the game's actual behaviour graphs and therefore failed silently at runtime.
What actually unlocked progress was **human guidance from `.doxr` on Discord**, who suggested **decompiling the `.hkx` behavior files** and reading the unpacked graph XML (see the `F4-Animation-Research` work around `MTBehavior.hkx` / `RaiderRootBehavior`). Only after that did the correct variable names, types, and weapon-behavior paths get wired into the plugin. Weapon model display and partial weapon animation sync likewise depended on in-game testing, logs, and that kind of targeted research — not on AI guesses about undocumented graph internals. Progress was made through human guidance from `.doxr` on Discord, who recommended decompiling the relevant `.hkx` behaviour files and examining their unpacked graph XML. This research, documented through the `F4-Animation-Research` work involving files such as `MTBehavior.hkx` and `RaiderRootBehavior`, revealed the correct variables, types, and weapon-behaviour paths required by the plugin. Weapon display and partial animation synchronisation also depended on repeated in-game testing, runtime logs, and targeted community research.
If you contribute to or review this repository, treat AI-generated code and documentation as a **starting point**. Verify behavior against the game, [`docs/protocol.md`](docs/protocol.md), and community research before assuming it is correct. AI-assisted code and documentation should therefore be treated as a starting point rather than a source of truth. Contributors are responsible for reviewing and testing anything they submit. Behaviour should be verified against the game, project documentation such as [`docs/protocol.md`](docs/protocol.md), runtime evidence, and relevant community research before it is considered correct.
--- ---