Configuration files

After successfully downloading the mod schema and following the steps from the previous page, it is essential to configure the mod you are creating and changing its settings.

What are configuration files

Configuration files can be used to customize the mod you are creating, like changing its name, description, author, and other relevant information.

If you do not have experience manually configuring these parameters, it is recommended to use the SwordigoPlus Workspace IDE which can simplify your work.

Updating the configuration file

To make changes to the configuration file, head over to the folder of the mod, and locate the file with the name config.json inside the folder. To open the configuration file, you can use one of the following tools for your operating system.

• Windows: Notepad, Visual Studio Code, Notepad++.

• Mac: TextEdit, Visual Studio Code.

• Linux: Gedit, Kate, Leafpad, Mousepad, Visual Studio Code, Notepad++.

• Android: DroidEdit, PocketEditor, MT Manager.

• IOS: Koder, iEditor.

Tools that are not listed can be used, for example applications that come bundled with your operating system.

Understanding the configuration file

The configuration file uses the JSON language and can be edited with an editor of your choice. If you do not understand the syntax, you can always ask our community any question.

Parameters to configure

There are multiple customizable parameters, as you can find below.

Parameter	Description	Type
name	The name of the mod that will be visible to players.	string
description	The short description of the mod that will be visible to players.	string
author	The name of the creator of the mod, visible to the players.	string
icon	The path to the file where the icon of the mod is located.	string
version	The current version of the mod.	number
language	The main language the mod is written in.	string

Advanced parameters

The configuration file has some more advanced parameters that can be useful to fully customize the behavior of your mod, however, be careful while making changes to these options as you can break the mod.

Parameter	Description	Type
permissions	Lists the permissions and APIs the mod is allowed to use.	collection
requirements	List the version requirements of the framework and the game.	collection
onlineConfig	Contains the keys and IDs for online services provided by SwordigoPlus.	collection
executionConfig	Defines how the game should execute the scripts and code.	collection
dependencies	Defines the packages and dependencies the mod uses.	collection
assetsManager	Defines if new assets should be loaded into the game.	collection

Making changes to these parameters can make your mod slow, or have different issues. It is recommended to be careful while doing changes to these parameters.

Example configuration file

If stuck with the syntax and configuration, you can look up at an example configuration file. We have also listed one here for beginners.

{
	"name": "Mod Name Here",
	"description": "Mod short description here",
	"author": "SwordigoPlus",
	"icon": "assets/icon.png",
	
	"version": "1.0.0",
	"language": "en-US",
	
	"permissions": [
		"net.api.request",
		"net.api.send",
		"net.api.socket",
		"net.api.status",
		"core.api.profile",
		"device.api.battery",
		"console.api.write"
	],
	
	"requirements": {
		"game": {
			"target-game-version": "1.4.6",
			"min-game-version": "1.0.0",
			"max-game-version": "1.4.6"
		},
		"framework": {
			"target-framework-version": "1.0.0",
			"min-framework-version": "1.0.0",
			"max-framework-version": "1.0.0"
		}
	},
	
	"onlineConfig": {
		"marketplaceAPI": "keyhere",
		"coreServicesAPI": "keyhere"
	},
	
	"executionConfig": {
		"entryPoint": "scripts/main.lua",
		"showErrors": false
	},
	
	"dependencies": {
		"easyCode": "1.0.0"
	},
	
	"assetsManager": {
		"loadNewTextures": true,
		"loadNewModels": true,
		"loadNewSounds": true,
		"loadNewMusic": true,
		"loadNewStrings": true
	}
}

This is an example configuration file, and can be modified to be suitable for your mod.