Difference between revisions of "Plugin Configuration Files"

From Desolation REDUX Wiki
Jump to navigation Jump to search
(Created page with "=== What is the plugin Configuration? === The Plugin Configuration file is a collection of all customizable values for server owners. This is a simpler structure than an addo...")
 
(updated Plugin Configuration Files structure)
 
Line 4: Line 4:
  
 
=== Configuration structure ===
 
=== Configuration structure ===
 +
The core of all Plugins is the config file, which has the file name config.cpp and needs to be present in the root of every plugin is.The following sections will describe possible options for the config file, the chosen name for the Plugin is ExamplePluginName and the folder containing the Plugin will also be called ExamplePluginPath. It is convenient to name the base folder for a plugin after its name, but its not required. The folder name can differ from the plugin name, but we strongly recommend to match the folder name with the plugin name!This Plugin differentiates them, to visualize the difference between them.You are required to add the Plugin Header as well as the Plugin Information. All other definitions are optional.
 
 
 
The configuration is structured like so:
 
The configuration is structured like so:

Latest revision as of 16:24, 20 March 2020

What is the plugin Configuration?[edit]

The Plugin Configuration file is a collection of all customizable values for server owners. This is a simpler structure than an addon Config.cpp and does not require unpacking and repacking the addons PBO.

Configuration structure[edit]

The core of all Plugins is the config file, which has the file name config.cpp and needs to be present in the root of every plugin is.The following sections will describe possible options for the config file, the chosen name for the Plugin is ExamplePluginName and the folder containing the Plugin will also be called ExamplePluginPath. It is convenient to name the base folder for a plugin after its name, but its not required. The folder name can differ from the plugin name, but we strongly recommend to match the folder name with the plugin name!This Plugin differentiates them, to visualize the difference between them.You are required to add the Plugin Header as well as the Plugin Information. All other definitions are optional.

The configuration is structured like so:

Key = Value

Each line can represent a new key and value, however lines can be skipped and comments can be inserted by prefixing the line comment with a # symbol.

Example[edit]

#Player Spawning
	#spawn area configs(TEMP)

		Zone1Button = South East
		Zone1Marker = Spawn_North
		Zone1ShoreMode = true
	
		Zone2Button = East
		Zone2Marker = Spawn_East
		Zone2ShoreMode = true	
		
		Zone3Button = South West
		Zone3Marker = Spawn_South
		Zone3ShoreMode = true