open-modding-alliance/scriptlibrary

FS Script Library is a collection of new features and helpful utility classes for Farming Simulator 22 mods

FS Script Library

The unofficial extension to the base game Lua library, adding new features and quality-of-life helper libraries, making this your one-stop-shop and starting point for all your mods.

With a non-intrusive opt-in approach running in the mod sandbox you can safely add this to any mod without any risk of version conflicts or bloating your mod. You choose what features to enable and to what extent you want to utilize the library.

If you have any suggestions, find an issue or maybe even have your own nifty functions you want to share with others, we gladly accept your contribution (see the Contribute section below for options and details).

INSTALLATION

To install the FS Script Library you have three options:

A. Get The Bootstrap Mod

The quickest way to get started with a new mod is the Bootstrap Mod that is the foundation for a complete ready-to-run mod with FS Script Library already installed. To add script library to an existing mod, the automatic or manual installation is recommended.

B. Automatic Installation

Run the script below via the command line in the root of your mod folder (e.g. '%UserProfile%/Documents/FarmingSimulator2022/mods/MyMods'):

curl -s http://myscript.com/download.bat | cmd

IMPORTANT! Never trust code you download from the internet, please review the contents of the script above (URL) if you are not certain about the content.

C. Manual Installation

1. Download the latest archive
2. Unzip the zip archive to the root of your mod folder

USAGE

GETTING STARTED

REFERENCE

scriptLibrary/extensions/ - Extensions to base game classes

• ModHelper - QoL wrapper and helper library to create your script mod

scriptLibrary/extensions/

ALL

• extensions: extension to base game classes
  • ModHelper
• ui:
• placeables:
• specializations:
• utils:
• misc: