Spine Tutorial – tool.cfg

Introduction

The tool.cfg is an ini file placed in the base directory of the modification that allows some additional configurations. First it was introduced to enable a required feature for Gothic One Click Action, later on it was used for Gothic Multiplayer mods, but now it has features for everybody.

So, that’s the general information, let’s have a look in the entries.

CONFIG

The CONFIG section contains basic configuration stuff.

BackgroundProcess

The BackgroundProcess contains the path relative to the executable that shall be started in background. It will be started and ended automatically with the modification. Currently it’s only used for Gothic One Click Action to start the key tracker in background and map it to the Gothic commands.

GMP

The GMP section contains the settings necessary to start a Gothic Multiplayer mod. That’s just the IP and port of the server the mod runs on.

IP

The IP of the server: 123.456.789.0

Port

The port of the server: 12345

G2O

The G2O section contains the settings necessary to start a multiplayer mod created with the G2O framework. That’s just the IP and port of the server the mod runs on.

IP

The IP of the server: 123.456.789.0

Port

The port of the server: 12345

DEPENDENCIES

Some modifications do have dependencies to some patches like the Systempack and there was no way to enforce these patches in Spine. So especially the Systempack dependency was solved by adding the Systempack again directly to the mod. That’s stupid because it duplicates files on the server, so together with mud-freak we figured out a nice way to make both dependencies and blocked patches be configurable for modders.

Required

Here you define the patch IDs that are required to start the modification/patch. They will automatically be enabled if installed, otherwise the player will see an error message. You can find the patch IDs in the database.

NOTE: The list is comma separated and if you have more than one entry you will need to add “” around them.

Blocked

Here you define the patch IDs that are blocked for your modification/patch. They will automatically be disabled when starting the modification even when selected in the Patches & Tools box. You can find the patch IDs in the database.

NOTE: The list is comma separated and if you have more than one entry you will need to add “” around them.

LOADER

Your mod requires a custom dll for some functionality and needs to be available right from the start? Systempack provides a pre.load file to add you dlls and Union also has a plugin list that can handle this, but with Spine there was no way to get this working. Now we added this.

SPpreload

This section is for the Systempack. Just add your dlls here. If you have multiple ones separate them with a comma and put “” around them.

UnionIni

This section is for Union. Just add you dlls here. If you have multiple ones separate them with a comma and put “” around them.

Example

And finally, here you have an example tool.cfg for inspiration.

[LOADER]
SPpreload=Ninja.dll
UnionIni="Ninja.dll**"

[GMP]
IP=123.456.789.0
Port=12345

[DEPENDENCIES]
Required=40
Blocked="41,42"