Consul Scriptum | Rome 2 Scripting Console

Consul Scriptum is a live scripting console and sandbox utility tool for Total War.

Whether you want to instantly kill a character, transfer a settlement, or write and test Lua scripts without restarting your game, this mod provides an interface directly inside your campaign.

For Players (No coding required):
It acts as a point-and-click sandbox tool. Open the "Consul" window, select a target on the map, and click a button to execute scripts instantly.

For Modders & Developers:
It is a live development environment. You can execute `.lua` files from your hard drive, test snippets in the console, inspect the UI and game world without closing or restarting the game.

– Rome 2
– Attila (Beta)
– Thrones of Britannia (Beta)

It’s simple: Subscribe, ensure it’s at the top of your load order, and Enjoy!
Modifies only the all_scripted.lua menu_bar sp_frame.xml.
Compatible with everything, save game compatible.

An immersive window with a list of built-in scripts.
Select a character or settlement, click the script, and watch it happen.

Included Scripts:

• Ad Rebellos — Spawns a rebellion in the selected settlement.
• Adice Provinciam — Transfers settlement ownership to another faction.
• Casus Belli — Forces a war declaration between two selected factions.
• Custodes Vocati — Exchanges the garrison of a settlement with a field army.
• Exterminare — Kills any selected character.
• Impetus — Fully restores action points for any selected character.
• Incrementum — Grants +1 Growth Point to the selected settlement.
• Pax Aeterna — Forces a peace agreement between two selected factions.
• Sedatio — Boosts public order by +10 across the selected settlement’s province.
• Subiugatio — Forces vassalage between two selected factions.
• Vexatio — Penalizes public order by -10 across the selected settlement’s province.

Raw access to Lua and extra commands.
Type commands, evaluate the game state, and debug your campaigns live.

Write your own scripts in an external text editor, place them in the game folder, and execute them with a click. When you save changes to your `.lua` file, just click the button again to run the updated code. No game restarts required.

Use built-in commands to quickly gather information about the state of the world.

Dedicated commands and a special HTML-based tool are available for debugging the UI (see documentation for more details).

Full instructions, API references, and video tutorials are available on the official documentation site:

➜ Read Documentation & Manual[consulscriptum.com]

• Source Code[github.com]
• Documentation & Manual[consulscriptum.com]
• Report Bugs on GitHub[github.com]
• Join the Discord Community[discord.gg]
• Support the Project on Ko-fi[ko-fi.com]

Consul Scriptum operates within the constraints of the Total War engine. Some features may have specific limitations depending on the game or campaign state. For a detailed breakdown of known constraints and how to handle them, please refer to our guide:

➜ Read Technical Limitations Guide[consulscriptum.com]

Consul Scriptum is an open-source project with a single codebase that currently runs across three different games. The Consul started from the Rome 2 UI base and reuses many existing components, which should be kept in mind if you ever find yourself frustrated with certain limitations. There is still much to be added—especially one-click scripts, which haven’t been the main focus for quite some time. I highly welcome contributions and feedback to help expand and improve the tool!

Individual Contributors

• DEI Discord Community — For their incredible help, insights, and support.
• Jake Armitage — For extra information and technical research.

Open Source & Libraries

• Taw’s ETWNG[github.com] — For the core research and decoding of UI pack files.
• Cpecific’s twwh2_ctm[github.com] — A UI Layout tool

Consul: In ancient Rome, a consul was one of the two highest-ranking elected officials who jointly governed the republic. The term later came to denote high-ranking officials or diplomats in other contexts.

Scriptum: This means "written" (from the verb scribere, "to write"). It can refer to a document, text, or written work.

Literally, "Consul Scriptum" translates to "written consul" or "the consul’s writing." However, this phrasing is not a standard Latin expression or historical term. Its meaning would depend on the context: It could metaphorically imply "the written authority" or "a document issued by a consul."

– Rome 2
– Attila
– Thrones of Britannia (Beta)

Download[github.com]