VoidExpanse/modding - Revision history

Ai enabled: /* Package files */

2018-02-26T11:50:31Z

Package files

← Older revision		Revision as of 11:50, 26 February 2018
Line 6:		Line 6:

	== Package files ==		== Package files ==
	All game data is loaded from two types of files: ".cpk" and ".mpk". Please note that basically, these files are just a regular ~~ZIP~~ archive (with no compression) and they should contain files directly, not in an extra subfolder.		All game data is loaded from two types of files: ".cpk" and ".mpk". Please note that basically, these files are just a regular .zip archive (with no compression) and they should contain files directly, not in an extra subfolder.

	===Core Package (CPK)===		===Core Package (CPK)===

Ai enabled: /* Package files */

2018-02-26T11:49:38Z

Package files

← Older revision		Revision as of 11:49, 26 February 2018
Line 6:		Line 6:

	== Package files ==		== Package files ==
	All game data is loaded from two types of files: ".cpk" and ".mpk"		All game data is loaded from two types of files: ".cpk" and ".mpk". Please note that basically, these files are just a regular ZIP archive (with no compression) and they should contain files directly, not in an extra subfolder.

	===Core Package (CPK)===		===Core Package (CPK)===
Line 15:		Line 15:

	Mod packages are loaded on top of the core package to add new features or content, or to change something that is already present in the game. The game can have multiple MPK files loaded at the same time.		Mod packages are loaded on top of the core package to add new features or content, or to change something that is already present in the game. The game can have multiple MPK files loaded at the same time.

	~~See also: [[VoidExpanse/Package_files_structure\|Package files structure]]~~

	== File precedents and overloading ==		== File precedents and overloading ==

Askew1: /* Structure */

2015-04-18T18:30:50Z

Structure

← Older revision		Revision as of 18:30, 18 April 2015
Line 47:		Line 47:
	All the elements are mandatory for a mod and must be properly specified.		All the elements are mandatory for a mod and must be properly specified.

	'''Modtype''' is a special parameter which defines whether a mod should be loaded on server, on client, or on both. For example, if we want to create a mod which just replaces some icons, that would be a typical ~~'''~~client~~'''~~ mod. Client-side mods will be ignored by ~~server,~~ if listed in ModsConfig.xml. On the other hand, mods that contains only server-side alterations, like new topics or scripts are typical ~~'''~~server~~'''~~ mods. If they are listed in ModsConfig.xml, server will load them, but ~~the~~ clients ~~wont~~, and the server won't demand that the player have ~~then~~ in order to play. ~~It means~~, ~~that if server has~~ server-side ~~mod, and~~ client ~~is not~~ - it'~~s okay.~~ Lastly ~~ther~~ is client-server mod, which is needed on both client and server. If a server was created with specific server~~-client~~ mod, and client doesn't have the same one, server won't let client to connect.		'''Modtype''' is a special parameter which defines whether a mod should be loaded by a server, client, or both.

			* '''client''' - For example, if we want to create a mod which just replaces some icons, that would be a typical client mod. Client-side mods will be ignored by servers if listed in '''ModsConfig.xml'''.
			* '''server''' - On the other hand, mods that contains only server-side alterations, like new topics or scripts, are typical server mods. If they are listed in '''ModsConfig.xml''', a server will load them but clients won't, and the server won't demand that the player have them in order to play. Again, clients do not need any server-side mods to connect.
			* '''client-server''' - Lastly there is a client-server mod, which is needed on both client and server. If a server was created with a specific client-server mod and the client doesn't have the same one, the server won't let the client connect.

	===Location===		===Location===

Askew1: /* Version Handling */

2015-04-18T18:17:12Z

Version Handling

← Older revision		Revision as of 18:17, 18 April 2015
Line 60:		Line 60:

	===Version Handling===		===Version Handling===
	Now, the way the game treats mod files is actually a bit more tricky. This is because you might have different versions of the same mod in your mods folder and since they share the same ID how would the game know which one to load?

	~~To resolve this when a mod is loaded version of~~ the mod is ~~specified as well, along with its ID~~. ~~The full internal ID for a mod~~ is ~~[id]_[version]. For instance, unique ID~~ of ~~this~~ mod ~~from~~ the ~~above example~~ would ~~be '''unique_mod_id_1.0.0'''.~~		The way the game treats mod files is actually a bit trickier. This is because you may have different versions of the same mod in your mods folder and since they share the same ID how would the game know which one to load?

	To determine which mods the game should load there's a file '''ModsConfig.xml''' (usually located in the user documents folder). All mods, that should be loaded, should be listed in this file.		When a mod is loaded, the version of the mod must be specified along with its ID. The full internal ID for a mod is [id]_[version]. For instance, the unique ID of this mod from the above example would be '''unique_mod_id_1.0.0'''.

			To determine which mods the game should load, there's a file '''ModsConfig.xml''' (usually located in the user documents folder). All mods that should be loaded should be listed in this file.

			The management of this file is now handled by the game. It will scan any MPK files in the mods folder and active mods can be selected by using the '''Mods''' option at the main menu. However, you can still manually edit the '''ModsConfig.xml''' if you wish.

	{{Main\|VoidExpanse/installing_mods\|Installing and using mods}}		{{Main\|VoidExpanse/installing_mods\|Installing and using mods}}

Askew1: /* Mods header structure */

2015-04-18T17:34:16Z

Mods header structure

← Older revision		Revision as of 17:34, 18 April 2015
Line 29:		Line 29:
	* File names are '''NOT''' case-sensitive. QWER.xml and qwer.xml are considered the same file!		* File names are '''NOT''' case-sensitive. QWER.xml and qwer.xml are considered the same file!

	== ~~Mods~~ header ~~structure~~ ==		== Mod header ==
	Each mod (MPK file) must have a valid "header.xml", or it won't be loaded. It is a simple XML document describing how the game should treat the mod file.		Each mod (MPK file) must have a valid "header.xml", or it won't be loaded. It is a simple XML document describing how the game should treat the mod file.
			===Structure===
	The structure of the "header.xml" is:		The structure of the "header.xml" is:
	<pre>		<pre>
Line 45:		Line 45:
	</root>		</root>
	</pre>		</pre>
	All ~~these~~ elements are mandatory for a mod and must be properly specified.		All the elements are mandatory for a mod and must be properly specified.

	The header file must be placed like so:		'''Modtype''' is a special parameter which defines whether a mod should be loaded on server, on client, or on both. For example, if we want to create a mod which just replaces some icons, that would be a typical '''client''' mod. Client-side mods will be ignored by server, if listed in ModsConfig.xml. On the other hand, mods that contains only server-side alterations, like new topics or scripts are typical '''server''' mods. If they are listed in ModsConfig.xml, server will load them, but the clients wont, and the server won't demand that the player have then in order to play. It means, that if server has server-side mod, and client is not - it's okay. Lastly ther is client-server mod, which is needed on both client and server. If a server was created with specific server-client mod, and client doesn't have the same one, server won't let client to connect.

			===Location===
			The header file must be placed in the root of the MPK like so:
	<pre>		<pre>
	root		root
Line 54:		Line 57:
	--> data/		--> data/
	</pre>		</pre>
	~~In the same folder with~~ content and data~~, that is~~.		The content and data folders are also on the same level.

			===Version Handling===
	Now, the way the game treats mod files is actually a bit more tricky. This is because you might have different versions of the same mod in your mods folder and since they share the same ID how would the game know which one to load?		Now, the way the game treats mod files is actually a bit more tricky. This is because you might have different versions of the same mod in your mods folder and since they share the same ID how would the game know which one to load?

Line 63:		Line 67:

	{{Main\|VoidExpanse/installing_mods\|Installing and using mods}}		{{Main\|VoidExpanse/installing_mods\|Installing and using mods}}

	Lastly, '''Modtype''' is a special parameter which defines whether a mod should be loaded on server, on client, or on both. For example, if we want to create a mod which just replaces some icons, that would be a typical '''client''' mod. Client-side mods will be ignored by server, if listed in ModsConfig.xml. On the other hand, mods that contains only server-side alterations, like new topics or scripts are typical '''server''' mods. If they are listed in ModsConfig.xml, server will load them, but the clients wont, and the server won't demand that the player have then in order to play. It means, that if server has server-side mod, and client is not - it's okay. Lastly ther is client-server mod, which is needed on both client and server. If a server was created with specific server-client mod, and client doesn't have the same one, server won't let client to connect.

	== Modding overview ==		== Modding overview ==

Askew1: /* Virtual file system concepts */

2015-04-15T12:24:16Z

Virtual file system concepts

← Older revision		Revision as of 12:24, 15 April 2015
Line 24:		Line 24:

	== Virtual file system concepts ==		== Virtual file system concepts ==
	* ~~All~~ mods are loaded into one virtual file system, with overwrite rule (~~see in~~ "File precedents and overloading" section above for explanation).		* The core and all mods are loaded into one virtual file system, with an overwrite rule (See "File precedents and overloading" section above for explanation).
	* Mods can use each other's files, so don't hesitate to use original game resources in your mods.		* Mods can use each other's files, so don't hesitate to use original game resources in your mods.
	* If two MPK files have the same file (path+name), the ~~last one (by~~ the ~~order specified in ModsConfig.xml)~~ will be ~~taken~~.		* MPK files are loaded in the order listed in '''ModsConfig.xml'''. If two MPK files have the same file (path+name), the file in the later MPK will be loaded.
	* ~~All file~~ names are ~~not~~ case-sensitive. ~~QwEr~~.xml and qwer.xml are considered the same.		* File names are '''NOT''' case-sensitive. QWER.xml and qwer.xml are considered the same file!

	== Mods header structure ==		== Mods header structure ==

Askew1: /* File precedents and overloading */

2015-04-15T12:13:26Z

File precedents and overloading

← Older revision		Revision as of 12:13, 15 April 2015
Line 19:		Line 19:

	== File precedents and overloading ==		== File precedents and overloading ==
	When mod file (or several mod files) is loaded it will merge with the already loaded core files into a so called "virtual file system". Even though the contents of ~~these separage~~ packages are stored separately the game will treat them as one file system with shared paths. Now, what does it mean?		When a mod file (or several mod files) is loaded it will merge with the already loaded core files into a so-called "virtual file system". Even though the contents of the core and mod packages are stored separately, the game will treat them as one file system with shared paths. Now, what does that mean?

	~~For~~ example, if we have CPK ~~(core package)~~ with a file "/content/some_file.txt" and MPK ~~(mod package)~~ with file "/content/some_file.txt" ~~which is~~ the same path. What happens when we start the game? Since both files in ~~core package~~ and ~~mod package~~ share the same path the ~~precedent~~ will ~~be given to~~ the ~~file store~~ in ~~mod package~~ since it was loaded ~~AFTER~~ the ~~core package~~. This mechanism ~~is created to make~~ it possible to override the core functionality and content ~~extremely easy,~~ without recompiling whole CPK or ~~need to modify~~ its content. The same principle works not just with content files, but with assets, scripts and any other type of files.		As an example, let's say we have a CPK with a file located at "/content/some_file.txt" and an MPK with a file "/content/some_file.txt" that has the same path and name. What happens when we start the game? Since both files in the CPK and the MPK share the same path, the file stored in the MPK will '''override''' the one in the CPK since it was loaded '''after''' the CPK. This mechanism makes it possible to override the core functionality and content easily without recompiling the whole CPK or modifying its content. The same principle works not just with content files, but with assets, scripts, and any other type of files.

	== Virtual file system concepts ==		== Virtual file system concepts ==

Askew1: /* Package files */

2015-04-15T11:36:57Z

Package files

← Older revision		Revision as of 11:36, 15 April 2015
Line 8:		Line 8:
	All game data is loaded from two types of files: ".cpk" and ".mpk"		All game data is loaded from two types of files: ".cpk" and ".mpk"

	~~".cpk" stands for~~ Core Package~~. It contains essential game functionality, basically foundation of the game. The game cannot run without a core package which contains all in-game assets and logic. Only one~~ CPK ~~file could be loaded at one time.~~		===Core Package (CPK)===

	~~But "~~.~~mpk" files on the other hand are "mod packages",~~ which can be ~~added~~ on top of the core package ~~file~~ to add new features or content, or to change something that is already present in the game. The game can have multiple ~~mpk~~ files loaded at the same time.		Core packages contain essential game functionality and are the foundation of the game. The game cannot run without a core package which contains all in-game assets and logic. Only one CPK file can be loaded at one time.

			===Mod Package (MPK)===

			Mod packages are loaded on top of the core package to add new features or content, or to change something that is already present in the game. The game can have multiple MPK files loaded at the same time.

	See also: [[VoidExpanse/Package_files_structure\|Package files structure]]		See also: [[VoidExpanse/Package_files_structure\|Package files structure]]

Askew1: /* Overview */

2015-04-12T10:47:25Z

Overview

← Older revision		Revision as of 10:47, 12 April 2015
Line 1:		Line 1:
	== Overview ==		== Overview ==
	VoidExpanse is designed to have great modding potential. Almost every aspect of game can be modified and extended.		VoidExpanse is designed to have great modding potential. Almost every aspect of the game can be modified and extended.
	There are no ~~hardcoded~~ scripts ~~and~~ in-game logic~~, everything~~ you see in VoidExpanse ~~now~~ was created as a "core" mod. This concept is similar to early GameBryo versions.		There are no hard-coded scripts or in-game logic. Everything you see in VoidExpanse was created as a "core" mod. This concept is similar to early GameBryo versions.

	The game uses so called "package files" to load all external content and logic, both for client and server.		The game uses so-called "package files" to load all external content and logic, both for the client and server.

	== Package files ==		== Package files ==

Atomic-admin: /* Mods header structure */

2015-01-08T10:34:59Z

Mods header structure

← Older revision		Revision as of 10:34, 8 January 2015
Line 41:		Line 41:
	</root>		</root>
	</pre>		</pre>
	All ~~this~~ elements are mandatory for a mod and must be properly specified.		All these elements are mandatory for a mod and must be properly specified.

	Now, the way the game treats mod files is actually ~~not self explanatory~~. This is because you might have different versions of the same mod in your mods folder and since they share the same ID how would the game know which one to load?		The header file must be placed like so:
			<pre>
			root
			--> header.xml
			--> content/
			--> data/
			</pre>
			In the same folder with content and data, that is.

			Now, the way the game treats mod files is actually a bit more tricky. This is because you might have different versions of the same mod in your mods folder and since they share the same ID how would the game know which one to load?

	To resolve this when a mod is loaded version of the mod is specified as well, along with its ID. The full internal ID for a mod is [id]_[version]. For instance, unique ID of this mod from the above example would be '''unique_mod_id_1.0.0'''.		To resolve this when a mod is loaded version of the mod is specified as well, along with its ID. The full internal ID for a mod is [id]_[version]. For instance, unique ID of this mod from the above example would be '''unique_mod_id_1.0.0'''.