FS Build

FSBuild is a command line utility to simplify and speed up some of the less creative and tedious tasks associated with modding for Farming Simulator, e.g. like creating your zip archive, convert images or run TestRunner. Think of it like a quality-of-life "swiss army tool"  for FS modding.

Features

• Builds a zip archive from your mod folder (with support for blacklisting files to be excluded)
• Run TestRunner tool on your zip archive (this is important to ensure that exactly the intended files are included in the zip file)
• Translate title, description and/or all language_XX.xml files. This uses DeepL AI based automagic translations. Supports EN, DE and FR currently (I will add more if there is an interest).
• Bump mod version version number (can be executed separately or as part of the build process)
• Tag builds - adds a prefix to mod title and a suffix to the version, e.g. to indicate preview versions or GitHub specific releases
• Automate the conversion of images (icons, textures etc) to ensure they are properly encoded according to FS25 standard
• and more...

Installation

A quick overview of the installation process:

1. Download the latest version of FSBuild
2. Unzip the contents to a folder of your choice
3. Register the PATH where you unzipped the downloaded content
4. Run "fsbuild help" from any folder (e.g. a mod folder)

For more information how to configure the PATH, troubleshoot your installation and to properly configure the automatic translation, TestRunner etc, see detailed installation instructions.

Documentation/How to Use

The in-depth documentation can be found on Github.

Basic usage 

fsbuild <command> <subcommand>

Show help

fsbuild help

Build archive

fsbuild build

Execute TestRunner

fsbuild test

See detailed documentation on Github for instructions how to configure TestRunner properly.

More Information and Detailed Instructions

For more information, see detailed documentation on Github.