AoM: Retold − Developer Setup Guide

#xs-dev-setup

Using the following setup will massively improve your development speed when working with XS, so we strongly recommend using it. All recommended software is free.

Part 1: IDE/Editor

Visual Studio Code
Free to download at https://code.visualstudio.com

Editor Plugin: XS Code Extension
The extension file can be unpacked from ..\Steam\steamapps\common\Age of Mythology Retold\vscodeextensionretail.7z
If you cannot unpack .7z, download 7-zip at https://www.7-zip.org
In Visual Studio Code, click on the "Extensions" (sidebar) and then on the 3 dots and choose "Install from VSXI..."

Part 2: Documentation

Find the documentation in ..\Steam\steamapps\common\Age of Mythology Retold\doxygen_retail.7z, unzip it, and open index.html in the browser of your choice.

Further setup instructions can be found in the respective categories in #rm-dev-setup, #tr-dev-setup, and #ai-dev-setup.

#rm-dev-setup

Part 1: General Setup

Check #xs-dev-setup for the general setup.

Part 2: Game Setup

Go to the config folder:
..\Users\<your username>\Games\Age of Mythology Retold\<your steam ID>\config
Create user.cfg and user.con with correct file extensions.

Add these options to user.cfg:

noIntroCinematics
disableAssetPreloading
debugRandomMaps
generateRMConstants

Add these keybinds to user.con (replace somekey):

map("somekey", "game", "leaveGame()")
map("somekey", "game", "restartCurrentGame()")
map("somekey", "game", "restartCurrentGameWithSeed(-1)")
map("somekey", "root", "gadgetToggle(\"XSDebugger\")")
map("somekey", "world", "cameraLimit()")
map("somekey", "world", "viewEntireWorld()")
map("somekey", "world", "toggleRMVisualizer()")

🎓 Learn more about basic rm scripting here.

#tr-dev-setup

Part 1: General Setup

Check #xs-dev-setup for the general setup.

Part 2: Game Setup

Same config folder setup. Add to user.cfg:

noIntroCinematics
disableAssetPreloading
debugTriggers
enableTriggerEcho
generateTRConstants

Useful keybinds in user.con:

map("somekey", "game", "leaveGame()")
map("somekey", "game", "restartCurrentGame()")
map("somekey", "root", "gadgetToggle(\"XSDebugger\")")

#ai-dev-setup

Part 1: General Setup

Check #xs-dev-setup for the general setup.

Part 2: Config Setup

Same config folder setup. Add to user.cfg:

noIntroCinematics
disableAssetPreloading
AIDebug
generateAIConstants
runAsFastAsPossible 20

Part 3: Hotkey Setup

map("somekey", "root", "gadgetToggle(\"XSDebugger\")")
map("somekey", "aidebug", "AIDebugInfoToggle")

All AI-related configs usable in user.cfg:

AIvsAI
aidebug
aidebugScript
aibreakAtStart
airecompilescripts
aiHideWarningEchoes
aiHideEngineInfoEchoes
aiOutputPlanDestructionAndCreation
aiOutputResourceSelection
aioutputUnitAssignment
aiOutputFindBestUnit
aiOutputPlanAssignment
aiChatDelay
aiDontUpdate

These can be toggled in-game via the AI Debug Misc menu:

aiGraphicalBaseDebug
aiGraphicalPlanDebug
aiGraphicalPlanDebugAll
aiShowBPValueText
aiShowAreaDangerRatings

#index

Jump to: #xs-dev-setup, #rm-dev-setup, #tr-dev-setup, #ai-dev-setup.

Code Reference: RetoldFunctions, RetoldConstants.