FPS Plus Modding Wiki

Welcome to the FPS Plus Modding Wiki. Here you will find documentation and guides on how to make a mod using FPS Plus.

This wiki is very much a work in progress.

Getting Started

To create a mod that the game will recognize and load, you have to create a folder in the mods/ directory of FPS Plus. In that folder you must include a meta.json file with the following fields:

• uid: A unique indentifier that you can use to identify your mod in a script.
  • A good way to ensure that you pick a unique name is using reverse domain name notation, however this string can be whatever you want it to be.
• api_version: A string containing the API version this mod was built for. You can find this in the bottom left corner of the main menu screen.
• mod_version: The current version of your mod. This is a requirement for Polymod and can be anything.

You can and should also include other information like the mod's title and a description. If you want to find out everything you can include in the meta.json file check out this page in the Polymod documentation. Note that this page doesn't mention uid since it is not a standard Polymod feature.

You can also include an image called icon.png. This is an 80x80 image that will be used as the mod's icon in the mod menu in-game.

Adding Graphics to the Asset Preload

FPS Plus allows you to add graphics to a preload list so that users can pre-cache graphics if they so choose. To add custom mod assets to the preload list you need to add an object in meta.json called "preload" that can contain the following fields:

• characters: An array containing the paths of character graphics you want to preload. While you can add any image path, this should be reserved for character graphics or any graphics related to a character's objects.
• graphics: An array containing the paths of any other graphics you want to preload.

Note that the paths should use the same format as if you were loading them with Paths.image().

You can also use * as a wildcard to add every image in a folder or start a file with ! to exclude it even though it would normally be added with a wildcard.

Example:

"preload": {
	"characters": [
		"customBoyfriend", "customGirlfriend", "customOpponent"
	],
	"graphics": [
		"customNoteskin", "customStage/*", "!customStage/excludeMe"
	]
}