DocumentationAPI referenceCode examples
Contribute
Wiki/Overview
SINGLE PLAYER MODDING

X4: Foundations
Modding Wiki

Ships, UI, scripts and game data.
Practical guides for your mods.

40 guides and walkthroughs796 API entries For regular X4 mods

Create your first XML mod

ONE CHANGE · A CLEAR RESULT
01

Change ship properties

Patch the Elite Vanguard hull value.
From extension structure to verifying the result.

Step by step example
Add a ship → Create a UI → Write an MD script →

What would you like to change?

API reference

Ships and equipment

New ships, hull variants, models and equipment.

Articles: 4

Data and content

Properties, wares, prices, text and dependencies.

Articles: 4

XML and Mission Director

Patches, cues, events, variables and persistence.

Articles: 7

UI and Lua

Custom windows, buttons, settings and MD communication.

Articles: 6

Native integration

LuaJIT FFI, C++ and game version compatibility.

Articles: 1

API reference

Lua calls, MD elements and game properties.

Articles: 805

Your first XML patch

Explore the example

Patch one hull attribute without replacing the complete original file.

XML
<diff>
  <replace sel="/macros/macro[@name='ship_arg_s_fighter_02_a_macro']/properties/hull/@max">3600</replace>
</diff>

Learning example The original field was checked against X4 9.00 files; this example was not separately run in game.

Useful foundations

HOW MOD FILES FIT TOGETHER

New to modding? Read how X4 code works and the operators and functions cheat sheet.

01 / SHIPSMacro, component and ware are different layers

Find the model, properties and ship ware.

 02 / TEXTAdd your own name and description

Language files, text pages and {page,id} references.

 03 / VERIFICATIONVerify the effect in a single player game

Loading, correct values, persistence and compatibility.

Practical guides

FROM SIMPLE TO ADVANCED
Adding a new shipFrom a variant of an existing hull to a separate ship: macro, indexes, ware, text and availability.Reference materialCreating a custom windowBuild a Lua UI with a frame, table, text, button and correct cleanup.Learning exampleWares, prices and productionDistinguish price data, recipes, macros and ware availability in libraries/wares.xml.Reference materialCreating a ship modelThe Blender to X4 route: geometry, materials, LODs, collisions and connection points.Reference material
A SEPARATE SECTION

Getting started with X4Online code

A guided route through X4FO: the project map, ship rename flow, Python basics and your first task. Network architecture and walkthroughs have their own section.

Start exploring the code

All multiplayer and X4FO articles

↑ ↓ select ↵ open