FOnline: The Life After - Agent Instructions

Project front door for AI maintainers working on FOnline: The Life After (TLA). Read this before changing anything. Keep this file as the single source for agent-facing repository practices; CLAUDE.md and .github/copilot-instructions.md intentionally point here.

What This Project Is

• TLA is a multiplayer game built on top of the reusable fonline-engine submodule in Engine/.
• The split is engine plus game:
  • Engine/ - upstream engine submodule. Treat as external unless the task explicitly requires an engine change.
  • Scripts/*.fos - AngelScript gameplay, dialogs, quests, AI, GUI behavior, and server/client hooks. The folder is flat except for Scripts/Json/.
  • SourceExt/*.cpp / SourceExt/*.h - project-local native C++ extensions registered from CMakeLists.txt.
  • Critters/, Items/, Maps/, Dialogs/, Gui/, Texts/, Resources/ - authored game content and assets.
  • TLA.fomain - master engine/game config and [SubConfig] profiles.
  • CMakeLists.txt / CMakePresets.json - build glue. Default local preset is auto into Build/Auto.
• Authored repository content is English unless an existing player-facing content surface is already localized. The user usually converses in Russian; answer the user in Russian unless asked otherwise, but keep committed docs/code in English.
• Text packs are baked for russ engl; Client.Language = engl in the default config. When editing player-facing text, preserve the existing pack structure and update both language surfaces when the nearby content expects that.

Repository Orientation

• Engine/ - pinned fonline-engine submodule. Do not edit in place for game behavior; advance the SHA in coordinated chunks.
• Scripts/Content.fos - generated/baked content declarations. Do not hand-edit.
• Scripts/GuiScreens.fos - generated screen bindings. Source of truth: Gui/*.fogui plus Tools/InterfaceEditor/generate_gui_screens.py. Do not hand-edit unless you also update the owning .fogui code as described below.
• Scripts/GuiScreensExt.fos - hand-written companion to GuiScreens.fos; non-generated GUI logic lives here.
• Gui/*.fogui - GUI definitions and embedded screen script code.
• SourceExt/CommonExtension.cpp - SHA helpers shared by client/server.
• SourceExt/ServerExtension.cpp - server image checks, dialog plumbing, visibility hooks, critter busy/free stubs.
• SourceExt/ClientExtension.cpp - Game.FormatTags and client critter busy/free stubs.
• SourceExt/BakerExtension.cpp, SourceExt/DialogBaker.*, SourceExt/Dialogs.* - dialog bake/runtime support.
• SourceExt/ContentMigration.cpp - TLA-specific content/data migrations. This is not present in lf-7.
• SourceExt/SHA/ - bundled SHA implementation wrapped as a static library.
• Tools/Formatter/format_project.py and FormatSource.bat - formatting entry points. VS Code tasks use the Python formatter.
• Tools/InterfaceEditor/generate_gui_screens.py - supported GUI screen generator.
• Build/runtime logs are written to repo root: TLA_Server.log, TLA_ServerHeadless.log, TLA_Client.log, TLA_Baker.log, TLA_ASCompiler.log, TLA_Mapper.log, Build/_bake.log, Build/_errors.txt.
• Built binaries land under Binaries/; baked output lives in Baking/; cache in Cache/; resource trees in Resources/.

Adding or removing a native extension file requires updating the relevant AddEngineSources(...) block in CMakeLists.txt under COMMON, SERVER, CLIENT, or BAKER.

Build And Verify

VS Code tasks in .vscode/tasks.json are the authoritative workflow. The same commands can be run directly from the terminal.

Task	When to use
Bake Resources	After edits in Scripts/, Dialogs/, Maps/, Items/, Critters/, Texts/, Gui/, or TLA.fomain.
Force Bake Resources	When incremental baking may be stale. Use sparingly.
Compile AngelScript	Fast script syntax/API check.
Build :: TLA_Server, Build :: TLA_ServerHeadless, Build :: TLA_Client, Build :: TLA_Mapper, Build :: TLA_Editor, Build :: TLA_Baker, Build :: TLA_ASCompiler, Build :: TLA_UnitTests	Build one target in Build/Auto, RelWithDebInfo.
Prepare :: TLA_*	Bake Resources plus the corresponding build target.
Launch :: TLA_Server [windows] / [linux]	Build, bake, then run the server with LocalTest.
Launch :: TLA_UnitTests [windows] / [linux]	Build, bake, then run engine unit tests.
Generate :: GuiScreens.fos	Regenerate Scripts/GuiScreens.fos from Gui/*.fogui.
Generate :: Version	Update VERSION via Tools/GenerateVersion/generate_version.py; do not hand-edit VERSION.
Format :: Scripts, Format :: Prototypes, Format :: Main Config, Format :: All	Format the relevant authored files.

Typical command equivalents:

cmake --build Build/Auto --config RelWithDebInfo --target BakeResources
cmake --build Build/Auto --config RelWithDebInfo --target TLA_Server
cmake --build Build/Auto --config RelWithDebInfo --target TLA_Client

Baseline verification after an engine bump or broad script/content change:

1. Bake Resources
2. Build :: TLA_Server
3. Build :: TLA_Client
4. If runtime startup matters, run TLA_ServerHeadless or Launch :: TLA_Server [windows] and confirm startup reaches "Start server complete!".

For native engine-facing changes, also build/run TLA_UnitTests when the touched surface is covered by engine tests.

Engine Update Workflow

The engine moves frequently. Handle submodule bumps deliberately:

1. Inspect Engine status and recent upstream commits first.
2. Prefer fast-forwarding Engine at coherent upstream boundaries instead of a large blind jump.
3. After each bump: Bake Resources -> build affected targets -> fix script/config/native fallout.
4. Cross-check H:/lf-7 when upstream renames or signatures shift. It runs on the same engine and often has the migration pattern already.
5. Do not commit, stage, or push unless the user explicitly asks. The user reviews and commits changes themselves.

Typical breakage points after a bump:

• New engine settings required in TLA.fomain.
• ///@ EngineHook rename or signature change in SourceExt/*Extension.cpp.
• AngelScript core type/API changes (hstring, any, ident_t, mpos/mdir, collection APIs).
• Logging or stack-trace API changes.
• New init-path guards such as if (IsTestingInProgress) return;.
• Baker/CMake API changes around AddEngineSources(...), AddDirSource(...), or generated metadata.

Engine Vs Game Boundary

Before adding behavior, pick the narrowest correct layer:

1. Gameplay rules, quests, dialogs, AI, GUI behavior -> AngelScript in Scripts/ or authored content.
2. Project-specific native bridge or helper -> SourceExt/, wired through CMakeLists.txt.
3. Reusable engine capability -> Engine/ only when the change belongs to every game using the engine.
4. Runtime/build configuration -> TLA.fomain or a [SubConfig].

When a serialized contract changes (properties, save data, network-visible data, generated content IDs), check whether ///@ MigrationRule metadata or a config/version bump is required.

Native Extensions

Native exports use engine annotations:

• ///@ EngineHook - lifecycle or behavior hook. Name/signature are dictated by engine codegen.
• ///@ ExportMethod - binds C++ functions into AngelScript. The first argument is the receiver (ServerEngine*, ClientEngine*, BaseEngine*, Critter*, CritterView*, etc.). The AngelScript name comes from the Server_ / Client_ / Common_ suffix mapping, e.g. Server_Game_LoadImage -> Game.LoadImage on server.

Native C++ conventions:

• Match existing engine/source style before introducing a new pattern.
• Use FO_SCRIPT_API on exported methods/hooks.
• For non-trivial engine/native functions, follow nearby stack-trace practice (FO_STACK_TRACE_ENTRY() or FO_NO_STACK_TRACE_ENTRY()), especially in engine-facing hooks.
• Prefer FO_RUNTIME_ASSERT / FO_RUNTIME_ASSERT_STR for invariants over silent fallbacks.
• Use fixed-width engine aliases (int32_t, uint32_t, float32_t, size_t, etc.) where the surrounding code does.
• Use numeric_cast for numeric conversions when narrowing/widening matters.
• Use pointers for Entity-derived objects unless the existing API requires references.
• Use file-local static helpers; avoid introducing hidden mutable static state.
• Add const/noexcept when they express the real contract, not mechanically.
• Keep edited source files ending with exactly one trailing blank line.

AngelScript Conventions

• Each .fos file declares a namespace matching its filename (CritterActions.fos -> namespace CritterActions).
• There are no #include directives; baking sees all .fos files. Cross-module calls use Namespace::Function().
• Use #if SERVER, #if CLIENT, and #if MAPPER carefully. Side-specific bugs are often missing or stray guards.
• Keep authoritative gameplay state changes on the server. Client scripts should focus on UI, input, presentation, and client-only probes.
• Mark startup functions with [[ModuleInit]]; subscribe to events from ModuleInit(). Attribute-marked functions are called by their attribute system; move reusable logic into plain helpers instead of calling attribute entrypoints directly.
• Event handlers return void for implicit continue or EventResult for explicit ContinueChain / StopChain.
• Do not pass inputs by const &. Use plain & only for genuine out/inout value-type parameters.
• Use explicit time helpers (Time::Milliseconds, Time::Seconds, Time::Asap) for game timing where available.
• Prefer engine/game geometry helpers such as Game.GetDistance(), Game.GetDirection(), pathing, and tracing APIs instead of inventing rectangular-grid math. TLA uses hex-grid assumptions.
• Do not mask invariant failures with broad defensive fallbacks. Assert or fail loudly when an expected value is absent.
• Add server-side Game.Log(...) lines only when they materially help diagnose positive and negative flows.
• Script changes often affect authored assets: dialogs, text packs, item/critter/map prototypes, GUI callbacks. Check references when changing public symbols or behavior.
• Keep edited .fos files ending with exactly one trailing blank line.

Content Pipeline

Authored inputs:

Scripts/*.fos, Scripts/Json/*.fos
Critters/*.focr, Items/*.foitem, Maps/*.fomap
Dialogs/*.fodlg, Gui/*.fogui, Texts/*.fotxt
Resources/*

Pipeline:

Gui/*.fogui
  -> Tools/InterfaceEditor/generate_gui_screens.py
  -> Scripts/GuiScreens.fos

Authored sources + generated script files
  -> BakeResources / ForceBakeResources
  -> baked configs, scripts, protos, maps, dialogs, text, resource packs
  -> Binaries/ consume baked output

A file can bake successfully and still be semantically wrong. Debug content by starting from the consumer: combat code for combat data, dialog code for .fodlg demand/result failures, GUI code for .fogui callbacks, and so on.

GuiScreens.fos Pitfall

Scripts/GuiScreens.fos is generated only by Tools/InterfaceEditor/generate_gui_screens.py. The VS Code task Generate :: GuiScreens.fos is already wired to that script.

Do not use the legacy Tools/InterfaceEditor/InterfaceEditor.exe -SilentGenerate path for TLA generation; it emits an incompatible layout for this project.

AngelScript embedded in screens lives in the .fogui JSON: OnGlobalMouseDown, OnLMouseClick, GlobalScope, ClassFields, OnDraw, callbacks listed in CALLBACK_METHODS, plus CODE_KEYS in the generator. If you fix behavior inside generated screen code:

1. Find the owning .fogui file.
2. Apply the same edit there.
3. Apply the same edit to Scripts/GuiScreens.fos if the baked project needs the fix immediately.
4. Regenerate only when screen identity or non-code .fogui properties change, or when you intentionally want to refresh generated output.

Formatting And Generated Files

• Use Format :: Scripts, Format :: Prototypes, Format :: Main Config, or Format :: All before handing off when touched files need formatting.
• FormatSource.bat is a smaller formatter path for Scripts/*.fos, Scripts/Json/*.fos, SourceExt/*, and Gui/*.fogui.
• Do not hand-edit generated files: Scripts/Content.fos, generated Scripts/GuiScreens.fos without the matching .fogui update, baked output under Baking/, cache files under Cache/, or generated VERSION.
• Local working trees such as TLA-Dev/, Baking/, Cache/, and build folders are outputs/debug state, not canonical authored inputs.

Debugging

Pick the boundary before reaching for a heavy interactive session:

Symptom	Start with
Script compile error	Compile AngelScript, then inspect TLA_ASCompiler.log / Build/_errors.txt.
Content, dialog, map, or text bake error	Bake Resources, then inspect TLA_Baker.log, TLA_BakerLib.log, Build/_bake.log, Build/_errors.txt.
Native compile/link error	Build the narrowest TLA_* target and inspect the first compiler error.
Server startup/runtime issue	Build :: TLA_ServerHeadless or Launch :: TLA_Server [windows], then inspect TLA_ServerHeadless.log / TLA_Server.log.
Client presentation/input issue	Build :: TLA_Client, run the client/server pair, then inspect TLA_Client.log.
Engine regression	Check Engine upstream commits, compare H:/lf-7, then run/build TLA_UnitTests when applicable.

Commit Policy

• Do not run git commit, git add, git push, or destructive git commands unless the user explicitly asks.
• The worktree may contain user changes. Never revert or overwrite changes you did not make.
• If unrelated files are dirty, leave them alone. If touched files contain user changes, read them and work with them.
• Summarize changed files, verification, and any residual risk at the end of the task.

Quick Reference

• README.md - repo-root overview.
• TLA.fomain - main config and subconfigs (LocalTest, PublicGame, resource baking subconfigs).
• .vscode/tasks.json - authoritative build/generate/format/launch tasks.
• .vscode/launch.json - debugger launch profiles when present.
• CMakeLists.txt - target wiring and native extension roles.
• .github/workflows/ - CI definitions.
• H:/lf-7/AGENTS.md - reference project on the same engine; copy only generic, non-project-specific practices.