For Users - polytrackmods/PolyModLoader GitHub Wiki

This page covers how to use mods with the PolyModLoader.

Installation

There are 2 primary ways to play with PolyModLoader

Web version

In order to play with PolyModLoader, go to the github pages site. It is recommended you install the PolyProxy Mod in order to retain full online functions like leaderboards. Info on how to install mods can be found further down in this wiki page.

App version

You can also download a modified version of the PolyTrack app version from the releases tab. Just grab the zip file for your system. Note that unlike the web version, the app version does not automatically update, so remember to check the releases tab once in a while for new releases.

PolyModLoader

The PolyModLoader itself is intentionally made very barebones, doing literally nothing by itself. Therefore, most of these features are actually part of a separete mod called PMLCore.

Interface

The modified home menu:

PMLCore adds a new button to the home screen for Mods. Clicking this button will open another screen Where you can add mods, remove mods, load mods, unload mods, and change priority.

Some buttons are grayed out since there is no mod selected. To select a mod, you just have to click it once, and the appropriate options enable themselves.

The Add and Remove buttons do what you would expect them to, they are used to add and remove mods from your game. It is important to know that having a mod added doesn't mean it will do anything. For that, it has to be loaded using the Load button. The Unload button does the opposite of the load button, bringing the selected mod's state back into "Available".

Note: the PMLCore mod has some protections in place to make it extremely hard to accidentally unload.

Each mod will have this little button on its top right:

Once clicked, it will either open a screen designed by the developer of the mod showing information about the mod, or it will kick you out telling you that this mod doesn't have a description file.

The arrow buttons are a little special. They move the selected mod up and down the list, changing its priority. Priority matters a lot for technical reasons. A general rule is whichever mod makes the biggest changes should be higher up.

Now, you might have skipped everything past the Add button and gotten to this without knowing what anytihng means:

The mod URL, most likely supplied by whoever's mod you are trying to install, points to the root directory of a mod.

The mod version is the version of the mod you are trying to install, by default latest. Latest will get the latest version of that mod for the version of PolyTrack you are playing, as PolyModLoader supports multiple versions at once.

The Auto update dictates if PolyModLoader should always get the latest version, or only get the current latest and stay with that version. This setting is ignored if "latest" is not selected for the version.

Back into our mod list screen, Apply just reloads the page as that is necessary for new / modified mods to initialize properly.