Modding

Disclaimer

DLL modding goes against the Trailmakers Terms of Service, promoting it on the official Discord server will result in a temporary ban at first which will become a permanent ban for serial offenders.

Introduction

Trailmakers support modding through Lua scripting language. There is a full modding API, that can access and modify various properties in the game. It is supported for both multiplayer and singleplayer.

Modding functions are still growing between every release and is in active development. You can visit the official Discord Forum for modding to discuss and request new features, where you can also talk and get help from community members who does modding.

Modding is not support on consoles, and only on Steam version of the game. There are currently no plans to get modding support to other platforms.

Installing and using Mods

Example of Mod Menu window

Only the person hosting the multiplayer server can select which mods are active. You can also use mods in singleplayer sessions.

1. Download any of the many mods from the Steam Workshop, you can also download them directly from the game in the Workshop menu.
2. Start the game and a new session, we recommend Sandbox + Test Zone for trying out new mods.
3. After getting into the game, press Escape to bring up the In-Game Menu and then click on Session Options.
4. Now click Activate Mods and enable the mod(s) you downloaded.

Note: Custom Maps still requires you to load a (any) map, the custom map is loaded on top of the existing map.

Mods downloaded through Steam Workshop will be installed in your Steam workshop content folder for Trailmakers (Ex. C:\Program Files (x86)\Steam\steamapps\workshop\content\585420\<mod>)

You can also manually install mods by placing them in your trailmakers/mods/<mod> folder.

Creating Mods

Creating mods for Trailmakers requires understanding of general programming. There are various ways to approach this, but this will not be covered here. Brief tips for getting started:

• Check out other existing mods, the mods you download from Workshop you can read and modify as you wish.
• Check the Lua - Getting Started page, Lua - Book and Lua - 5.2 Documentation
• Check the Trailmakers Moddding API file inside the trailmakers/mods/trailmakers_docs.lua.
• Ask on official Discord Forum for modding

More comprehensive guide:

• Basic Modding Guide

And other modding topics:

• Modding:Game Loop and Tick
• Modding:ModGameObject
• Modding:ModTransform
• Modding:ModQuaternion
• Modding:ModVector3
• Modding:ModStructure
• Modding:ModBlock
• Modding:PlayerUI
• Modding:Physics
• Modding:Audio
• Modding:Files
• Modding:Spawnables
• Modding:Input
• Modding:Custom Assets

External Links

• Trailmakers Modding Discord Forum
• Mods on Steam Workshops