Skip to content

About

Verified knowledge, tools and a mod template for Farming Simulator 25 (FS25/LS25) Lua script mods: shop configurations, motor/gearbox, settings menu, HUD, used market, leasing, multiplayer. AI-friendly (llms.txt, API index).

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

448 Commits

Folders and files

Repository files navigation

LS25 / FS25 Modding Guide

Practical knowledge for Farming Simulator 25 (FS25 / LS25, GIANTS Engine 10) Lua script mods and vehicle conversions from FS19, collected while building a large gameplay mod (tuning, wear, used market, leasing, multiplayer) – with tools and a mod template.

Keywords: Farming Simulator 25 modding, FS25 Lua scripting, LS25 Mod erstellen, GIANTS Engine 10, modDesc, specialization, ConfigurationUtil.getConfigurationsFromXML, ShopConfigScreen, VehicleMotor, SpeedMeterDisplay, VehicleSaleSystem, EconomyManager, multiplayer events, dedicated server, AutoDrive and Courseplay interop, AIMessage, DashboardValueType, XMLFile.initInheritance, SellingStation, MissionManager, MoneyType, input actions, console commands, ModHub.

Using an AI assistant? Point it to llms.txt or CLAUDE.md: look up a game function in the API index, then read only the one topic file you need.

🇩🇪 Kurz auf Deutsch: Gesammeltes Wissen zum Bau von LS25-Skript-Mods aus der Entwicklung eines großen Gameplay-Mods: Motor und Getriebe, Shop-Konfigurationen, Einstellungsmenü, HUD, Gebrauchtmarkt, Mieten, Mehrspieler. Dazu Werkzeuge (Übersetzungs-Check, Testskript) und eine Mod-Vorlage. Alles auf Englisch, damit es möglichst viele nutzen können.

Contents

Topic
1. Sources and tools game source repos, reference mods, log, testing without the game, graphics
2. Mod skeleton modDesc, hooks, specializations, texts (l10n), help pages
3. Settings and menu savegame file, modSettings, own settings tab, menu pages, own dialogs, presets
4. Configurations and shop own configuration types, XML injection, shop configurator, buying in code, leasing, money bookings, workshop buttons
5. Motor and gearbox torque, top speed, gear groups, automatic, pedals, engine sound volume, sound layers (motor/gearbox/blowOffValve), turbo and transmission detection, motorSamples/gearboxSamples fields
6. Consumption, wear, value fuel, wear, repair, sell value
7. HUD and display speedometer, icons, notifications
8. Helpers (AI) stopping helpers, own AI messages, detecting and stopping AutoDrive and Courseplay
9. Used vehicle market VehicleSaleSystem, own offers, shop cells
10. Multiplayer roles, events, relay pattern, admin, per-player values, dirty flags, server-authoritative blueprint, sounds the game does not sync (blow-off valve, air compressor, hydraulics, tree cutting), isLocalSound
11. Pitfalls short list of mistakes we made and ones seen in other mods
12. Learned from other mods one section per published mod we read: license, link, notable techniques; compatibility table (what each mod overrides), More Motor Sounds, Multiplayer Game Sound Expansion
13. Input and player actions and bindings, vehicle/global/on-foot input, clicks on 3D points, player, attaching implements, selected driving direction (motor.currentDirection), passenger indoor sound
14. Development and debugging console commands, restart into the savegame, time scale, table dumps, debug drawing, debug builds
15. Dashboards and vehicle data live vehicle values, server-only motor values, vanilla dashboard value types, offering data/APIs to other mods
16. Economy, missions, placeables money types and booking paths, selling station prices, contracts, storages and capacities, fill units
17. Vehicle conversion and materials FS19→FS25 vehicles without Blender: reading/writing .i3d.shapes, colorMask zones and material slot names, white_diffuse, vmask channels, dirt formula, world-space detail textures, normal-map speckles, yes/no parts, rim and hub colour
18. Map conversion FS22→FS25 Roads as terrain decals, fitting terrain to roads, terrain poking through 3D roads, decal/mesh seams, road collision for traffic, traffic density, FS22 tree collision, road blend maps, map placeables
API reference (fs25-lua-api) name/key lists extracted from the FS25 Lua scripts (no code): all registered XML keys with type/default per specialization, functions per file, vehicle specializations with requirements/overwritable functions/events, console commands, shop spec types; plus a short own-words summary of loading, schema, configurations, shop specs and attaching
API index game function / class / global → topic file
Workflow versions, checks before delivery, log discipline, in-game testing, ground rules for every new mod
Tools translation check, run-all script, index builder
Mod template log + debug switch, savegame settings, multiplayer sync

Status markers

Marker Meaning
✅ confirmed in the game
📖 read from the (partial) game source
🔎 learned from another mod's code, not tested by us
❓ assumption, not confirmed

State: FS25 patch 1.24 (October 2026). Game updates can change things – if something no longer works, please open an issue.

Rules for this repo

  • No GIANTS source code and no code from other mods. Only own findings, function names and references to the sources.
  • Corrections and additions are welcome as issues or pull requests – please mark how you verified them (in game / source / other mod).

License

  • Texts (knowledge/, workflow.md, READMEs): CC BY 4.0 – use and adapt freely, with credit.
  • Code (tools/, template/): MIT.

Farming Simulator and GIANTS Software are trademarks of GIANTS Software GmbH. This project is not affiliated with GIANTS.

About

Verified knowledge, tools and a mod template for Farming Simulator 25 (FS25/LS25) Lua script mods: shop configurations, motor/gearbox, settings menu, HUD, used market, leasing, multiplayer. AI-friendly (llms.txt, API index).

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages