Browse documentation

Acquiring better BO3 references

Combine installed BO3 API manuals, stock scripts, author-written guides, and verified community evidence for more reliable agent context.

The best context connects a concrete task to the relevant API, working stock source, and a way to test the result. Apothicon bundles original guidance and attributed reference links. Your own Mod Tools installation supplies the engine manuals and stock scripts.

Start with your installation

Run index_installation, then inspect knowledge_status for missing roots or skipped files. The script API at docs_modtools/bo3_scriptapifunctions.htm describes function signatures and server/client availability. Stock source under share/raw/scripts and share/devraw/scripts shows how those functions fit the installed Zombies startup and feature lifecycle.

Use knowledge_search to find a feature, knowledge_read to read its context, and knowledge_find for an exact symbol or diagnostic. A useful answer should retain the source path and section it relied on.

Match references to the job

Task Evidence to inspect
GSC or CSC function call Installed API entry, its stock definition, and callers in the correct script context
Zombies progression, power, or perks Installed Zombies template, relevant stock feature scripts, and the current map’s integration
Radiant lighting or geometry Installed editor manuals and a small map reproducing the setting
Models, materials, sounds, or VFX Installed APE definitions, working asset examples, exporter source, and the linked variant
Build failure The first failing native stage, nearby diagnostics, and the inputs changed since the previous build
Workshop packaging Current Launcher behavior and the files produced by the installed toolchain

knowledge_sources lists the project’s current references, attribution, verification scope and local import hints. The source manifest on GitHub makes that selection reviewable outside the agent.

Use community reports as leads

Author-written BO3 guides can explain integration details absent from an API entry. Forum and Reddit reports can reveal common symptoms, terminology, and missing links. Check that the advice applies to BO3, the same map mode, and your installed version. Follow the original author’s examples and confirm the actual function or asset locally.

If reports conflict, keep that uncertainty visible until a source check or a native experiment resolves it. A suggestion that fixed somebody else’s map does not establish the cause of your build error.

Add local documents

Save documents you are entitled to use inside your workspace, then import their relative path with knowledge_import. Supported files include Markdown, text, HTML, script source and PDFs with a text layer. The importer runs locally, reports extraction gaps, and does not fetch URLs or perform OCR.

Re-import changed sources and inspect coverage after a Mod Tools update. If you use semantic search, refresh its index after updating the corpus. Keep third-party manuals private; a distributed release should contain original guidance and source links.

Check whether the context is enough

Try concrete questions about the feature you intend to build. Read the returned evidence and confirm that it identifies the relevant API, integration point and prerequisites. Search success establishes retrieval; native compilation and playtests establish whether the resulting feature works.

Project contributors can follow the knowledge acquisition guide for source records, retrieval benchmarks and guide maintenance. For a map, record the separate build and runtime evidence.

Search by topic or tool name.