AtomicTorchWiki - User contributions [en]

VoidExpanse/Server commands

2015-04-19T22:46:32Z

Askew1: /* Maintenance and setup commands */

= Server commands =
These are the commands that OP (server operator) can use in multiplayer. Some of the commands can also be used in singleplayer as cheats. If you are using them in singleplayer you can just open chat by pressing [Enter] and enter any of the commands. In multiplayer you can enter them both in the server console and in chat, but in that case you have to have an OP status.

== Legend ==
{| class="wikitable" style="text-align:center"
! If you see...
! Then
|-
| <''angle brackets''>
| This is a '''required argument'''.
|-
| [''square brackets'']
| This is an '''optional argument'''.
|-
| plain text
| '''Enter this literally''', exactly as shown.
|-
| ''x<nowiki> | </nowiki>y<nowiki> | </nowiki>z''
| '''Select one''' of the options.
|}

== List of commands ==

=== Maintenance and setup commands ===
{| class="wikitable" style="width:100%"
! width="25%" align="center" | Command
! width="25%" align="center" | Example
! width="5%" align="center" | OP Only
! width="45%" align="center" | Description
|-
|<code>/new [''seed'']</code>
|<code>/new tehseed12345</code>
|Yes
|Create a new world. If no seed is given it will create a world with a random seed. Otherwise it will use the given value.
|-
|<code>/save</code>
|<code>/save</code>
|Yes
|Saves the game immediately.
|-
|<code>/load</code>
|<code>/load 1</code>
|Yes
|Loads a savegame.
|-
|<code>/stop</code>
|<code>/stop</code>
|Yes
|Stops the game server.
|}

=== Access modification ===
{| class="wikitable" style="width:100%"
! width="25%" align="center" | Command
! width="25%" align="center" | Example
! width="5%" align="center" | OP Only
! width="45%" align="center" | Description
|-
|<code>/kick <''player''> [reason]</code>
|<code>/kick john123 because I don't want to see you on the server</code>
|Yes
|Kick a particular player from the server. You could also specify the reason for kicking.
|-
|<code>/whitelist <''add<nowiki>|</nowiki>remove<nowiki>|</nowiki>list''> [''player'']</code>
|<code>/whitelist add john123</code>
<code>/whitelist list</code>
|Yes
|Add or remove a particular player to/from the whitelist. Or get a list of players who are added to that list.
|-
|<code>/blacklist <''add<nowiki>|</nowiki>remove<nowiki>|</nowiki>list''> [''player'']</code>
|<code>/blacklist add john123</code>
<code>/blacklist list</code>
|Yes
|Add or remove a particular player to/from the blacklist. Or get a list of players who are added to that list.
|-
|<code>/op <''add<nowiki>|</nowiki>remove<nowiki>|</nowiki>list''> [''player'']</code>
|<code>/op add john123</code>
<code>/op list</code>
|Yes
|Add or remove a particular player to/from the operator list. Player given operator permissions can use these commands. Or get a list of players who are added to that list.
|}

=== Cheats ===
{| class="wikitable" style="width:100%"
! width="25%" align="center" | Command
! width="25%" align="center" | Example
! width="5%" align="center" | OP Only
! width="45%" align="center" | Description
|-
|<code>/pwn [''player'']</code>
|<code>/pwn john123</code>
|Yes
|Makes player into a badass by giving tons of money, exp and some important skills.
|-
|<code>/exp <''amount''> [''player'']</code>
|<code>/exp 9000 john123</code>
<code>/exp 9000</code>
|Yes
|Add some amount of experience to self or to a specified player.
|-
|<code>/money <''amount''> [''player'']</code>
|<code>/money 9000 john123</code>
<code>/money 9000</code>
|Yes
|Add some amount of money to self or to a specified player.
|-
|<code>/god [''player'']</code>
|<code>/god john123</code>
<code>/god</code>
|Yes
|Set god mode (invincibility) to yourself or to a specified player.
|-
|<code>/heal [''player'']</code>
|<code>/heal john123</code>
<code>/heal</code>
|Yes
|Fully heal yourself or a specified player.
|-
|<code>/item_add <''item_id''> [''amount''] [''player'']</code>
|<code>/item_add weapon_light_laser 3 john123</code>
<code>/item_add weapon_light_laser</code>
|Yes
|Add a specified item to yourself or to another player. If you are adding to yourself you don't have to specify the amount, but if you are adding an item to someone else you have to specify the amount always.
|-
|<code>/kill <''player''></code>
|<code>/kill john123</code>
|Yes
|Destroy a specified player's ship. Only works if the specified player is online. You can use it to destroy your own ship.
|-
|<code>/killall</code>
|<code>/killall</code>
|Yes
|Destroy all ships in a current system except your ship.
|-
|<code>/tp <''system name''> [''player'']</code>
<code>/tp <''x''> <''y''> [''player'']</code>
|<code>/tp Cosaden</code>
<code>/tp -120 85 john123</code>
|Yes
|Teleport your ship or a ship of another player to a different system or to a different coordinates in this system. See examples for usages of this command.
'''Note:''' If system name contains spaces it must be written with underscores. For example if the system name is "Vis Cosaden Alpha" it should be written as ''Vis_Cosaden_Alpha''.
|}

=== Other commands ===
{| class="wikitable" style="width:100%"
! width="25%" align="center" | Command
! width="25%" align="center" | Example
! width="5%" align="center" | OP Only
! width="45%" align="center" | Description
|-
|<code>/list</code>
|<code>/list</code>
|No
|Will return a list of all people on the server.
|-
|<code>/help [''command'']</code>
|<code>/help</code>
<code>/help quit</code>
|No
|Gives a list of all commands available to player. Some commands might not be accessible if the player is not an operator. If argument (command name) is provided it will give detailed information about that specific command.
|}

VoidExpanse/Troubleshooting

2015-04-19T22:40:19Z

Askew1: /* Firewall */

== Issue: Cannot start Singleplayer game ==
There are a few likely possible reasons why you may not be able to play VoidExpanse. Try and see what works for you!

=== Antivirus blocking the application / Unable to launch server ===
Your antivirus is blocking the VoidExpanse application. The best option to solve this issue would be to add VoidExpanse to your antivirus exclusions (white-list).

There are two files in Windows you have to add to the Antivirus exclusions list:

* ''<game folder>/VoidExpanse.exe''
* ''<game folder>/Server_dotNET/VoidExpanse.Server.exe''

There is still a chance that "VoidExpanse.Server.exe" can be sandboxed by an antivirus. To check this, please start a new game, then 'Save and Quit' and comeback to the main menu and try to load the savegame. If "VoidExpanse.Server.exe" has been sandboxed by the antivirus, the savegame will not appear in the list. To resolve this issue please reinstall the game and be sure you've added the executable files listed above to the exclusions list.

=== Firewall ===
Your firewall is blocking network access to the ''local server'' OR ''master server''. Even in singleplayer mode VoidExpanse uses networking to connect to a server (which in this case is running on your computer, so you don't need internet access). So, to resolve this issue both, the main application and server application should be added to exclusion list.

'''Note:''' ''You DON'T need Internet to play single-player game.''

There are two files in Windows you have to add to the Firewall exclusions list:

* ''<game folder>/VoidExpanse.exe''
* ''<game folder>/Server_dotNET/VoidExpanse.Server.exe''

=== Antivirus removing some critical files ===
Some people reported that some critical files, such as server executables were removed by their antivirus. You have to add these files or the whole folder into exclusions and the game would work.

=== Antivirus blocking creation of child process ===
Singleplayer mode works with a local server running on your computer silently, in invisible mode. This requires permission for VoidExpanse to start a child process. Your antivirus may be blocking it. The best option to solve this issue would be to add VoidExpanse to your antivirus exclusions.

=== Outdated MONO ===
Make sure you have the LATEST version of mono installed.
Please read this article: http://wiki.atomictorch.com/VoidExpanse/Mono_compatibility

VoidExpanse/Troubleshooting

2015-04-19T22:39:11Z

Askew1: /* Antivirus blocking the application / Unable to launch server */

== Issue: Cannot start Singleplayer game ==
There are a few likely possible reasons why you may not be able to play VoidExpanse. Try and see what works for you!

=== Antivirus blocking the application / Unable to launch server ===
Your antivirus is blocking the VoidExpanse application. The best option to solve this issue would be to add VoidExpanse to your antivirus exclusions (white-list).

There are two files in Windows you have to add to the Antivirus exclusions list:

* ''<game folder>/VoidExpanse.exe''
* ''<game folder>/Server_dotNET/VoidExpanse.Server.exe''

There is still a chance that "VoidExpanse.Server.exe" can be sandboxed by an antivirus. To check this, please start a new game, then 'Save and Quit' and comeback to the main menu and try to load the savegame. If "VoidExpanse.Server.exe" has been sandboxed by the antivirus, the savegame will not appear in the list. To resolve this issue please reinstall the game and be sure you've added the executable files listed above to the exclusions list.

=== Firewall ===
Your firewall is blocking network access to the ''local server'' OR ''master server''. Even in singleplayer mode VoidExpanse uses networking to connect to a server (which in this case is running on your computer, so you don't need internet access). So, to resolve this issue both, the main application and server application should be added to exclusion list.

'''Note:''' ''You DON'T need Internet to play single-player game.''

There are two files in Windows you have to add to the Firewall exclusions list:

''<game folder>/VoidExpanse.exe
<game folder>/Server_dotNET/VoidExpanse.Server.exe''

=== Antivirus removing some critical files ===
Some people reported that some critical files, such as server executables were removed by their antivirus. You have to add these files or the whole folder into exclusions and the game would work.

=== Antivirus blocking creation of child process ===
Singleplayer mode works with a local server running on your computer silently, in invisible mode. This requires permission for VoidExpanse to start a child process. Your antivirus may be blocking it. The best option to solve this issue would be to add VoidExpanse to your antivirus exclusions.

=== Outdated MONO ===
Make sure you have the LATEST version of mono installed.
Please read this article: http://wiki.atomictorch.com/VoidExpanse/Mono_compatibility

VoidExpanse/modding

2015-04-18T18:30:50Z

Askew1: /* Structure */

== Overview ==
VoidExpanse is designed to have great modding potential. Almost every aspect of the game can be modified and extended.
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 the client and server.

== Package files ==
All game data is loaded from two types of files: ".cpk" and ".mpk"

===Core Package (CPK)===

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]]

== File precedents and overloading ==
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?

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 ==
* 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.
* 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.
* File names are '''NOT''' case-sensitive. QWER.xml and qwer.xml are considered the same file!

== 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.
===Structure===
The structure of the "header.xml" is:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<id>unique_mod_id</id>
<title>Name of the mod</title>
<author>Author name</author>
<description>Brief description for the mod.</description>
<version>1.0.0</version> 
<updated>01.01.2015</updated> 
<modtype>2</modtype> 
</root>
</pre>
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 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===
The header file must be placed in the root of the MPK like so:
<pre>
root
--> header.xml
--> content/
--> data/
</pre>
The content and data folders are also on the same level.

===Version Handling===

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?

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}}

== Modding overview ==
Now, the modding itself consists of a few essential parts:
* [[VoidExpanse/Assets_modding|Assets modding]] - where you can add or change graphics, sounds, visuals and such.
* [[VoidExpanse/Content_modding|Content modding]] - adding new ships, weapons, items, or new quests, and basically extending the game content in some way.
* [[VoidExpanse/Scripting|Scripting]] - creating new mechanics that were not present in the original game.

{{Modding}}

VoidExpanse/modding

2015-04-18T18:17:12Z

Askew1: /* Version Handling */

== Overview ==
VoidExpanse is designed to have great modding potential. Almost every aspect of the game can be modified and extended.
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 the client and server.

== Package files ==
All game data is loaded from two types of files: ".cpk" and ".mpk"

===Core Package (CPK)===

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]]

== File precedents and overloading ==
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?

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 ==
* 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.
* 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.
* File names are '''NOT''' case-sensitive. QWER.xml and qwer.xml are considered the same file!

== 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.
===Structure===
The structure of the "header.xml" is:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<id>unique_mod_id</id>
<title>Name of the mod</title>
<author>Author name</author>
<description>Brief description for the mod.</description>
<version>1.0.0</version> 
<updated>01.01.2015</updated> 
<modtype>2</modtype> 
</root>
</pre>
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.

===Location===
The header file must be placed in the root of the MPK like so:
<pre>
root
--> header.xml
--> content/
--> data/
</pre>
The content and data folders are also on the same level.

===Version Handling===

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?

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}}

== Modding overview ==
Now, the modding itself consists of a few essential parts:
* [[VoidExpanse/Assets_modding|Assets modding]] - where you can add or change graphics, sounds, visuals and such.
* [[VoidExpanse/Content_modding|Content modding]] - adding new ships, weapons, items, or new quests, and basically extending the game content in some way.
* [[VoidExpanse/Scripting|Scripting]] - creating new mechanics that were not present in the original game.

{{Modding}}

VoidExpanse/modding

2015-04-18T17:34:16Z

Askew1: /* Mods header structure */

== Overview ==
VoidExpanse is designed to have great modding potential. Almost every aspect of the game can be modified and extended.
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 the client and server.

== Package files ==
All game data is loaded from two types of files: ".cpk" and ".mpk"

===Core Package (CPK)===

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]]

== File precedents and overloading ==
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?

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 ==
* 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.
* 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.
* File names are '''NOT''' case-sensitive. QWER.xml and qwer.xml are considered the same file!

== 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.
===Structure===
The structure of the "header.xml" is:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<id>unique_mod_id</id>
<title>Name of the mod</title>
<author>Author name</author>
<description>Brief description for the mod.</description>
<version>1.0.0</version> 
<updated>01.01.2015</updated> 
<modtype>2</modtype> 
</root>
</pre>
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.

===Location===
The header file must be placed in the root of the MPK like so:
<pre>
root
--> header.xml
--> content/
--> data/
</pre>
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?

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 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.

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

== Modding overview ==
Now, the modding itself consists of a few essential parts:
* [[VoidExpanse/Assets_modding|Assets modding]] - where you can add or change graphics, sounds, visuals and such.
* [[VoidExpanse/Content_modding|Content modding]] - adding new ships, weapons, items, or new quests, and basically extending the game content in some way.
* [[VoidExpanse/Scripting|Scripting]] - creating new mechanics that were not present in the original game.

{{Modding}}

VoidExpanse/modding

2015-04-15T12:24:16Z

Askew1: /* Virtual file system concepts */

== Overview ==
VoidExpanse is designed to have great modding potential. Almost every aspect of the game can be modified and extended.
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 the client and server.

== Package files ==
All game data is loaded from two types of files: ".cpk" and ".mpk"

===Core Package (CPK)===

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]]

== File precedents and overloading ==
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?

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 ==
* 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.
* 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.
* File names are '''NOT''' case-sensitive. QWER.xml and qwer.xml are considered the same file!

== Mods header structure ==
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.

The structure of the "header.xml" is:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<id>unique_mod_id</id>
<title>Name of the mod</title>
<author>Author name</author>
<description>Brief description for the mod.</description>
<version>1.0.0</version> 
<updated>01.01.2015</updated> 
<modtype>2</modtype> 
</root>
</pre>
All these elements are mandatory for a mod and must be properly specified.

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 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.

{{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 ==
Now, the modding itself consists of a few essential parts:
* [[VoidExpanse/Assets_modding|Assets modding]] - where you can add or change graphics, sounds, visuals and such.
* [[VoidExpanse/Content_modding|Content modding]] - adding new ships, weapons, items, or new quests, and basically extending the game content in some way.
* [[VoidExpanse/Scripting|Scripting]] - creating new mechanics that were not present in the original game.

{{Modding}}

VoidExpanse/modding

2015-04-15T12:13:26Z

Askew1: /* File precedents and overloading */

== Overview ==
VoidExpanse is designed to have great modding potential. Almost every aspect of the game can be modified and extended.
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 the client and server.

== Package files ==
All game data is loaded from two types of files: ".cpk" and ".mpk"

===Core Package (CPK)===

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]]

== File precedents and overloading ==
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?

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 ==
* All mods are loaded into one virtual file system, with overwrite rule (see in "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.
* If two MPK files have the same file (path+name), the last one (by the order specified in ModsConfig.xml) will be taken.
* All file names are not case-sensitive. QwEr.xml and qwer.xml are considered the same.

== Mods header structure ==
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.

The structure of the "header.xml" is:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<id>unique_mod_id</id>
<title>Name of the mod</title>
<author>Author name</author>
<description>Brief description for the mod.</description>
<version>1.0.0</version> 
<updated>01.01.2015</updated> 
<modtype>2</modtype> 
</root>
</pre>
All these elements are mandatory for a mod and must be properly specified.

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 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.

{{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 ==
Now, the modding itself consists of a few essential parts:
* [[VoidExpanse/Assets_modding|Assets modding]] - where you can add or change graphics, sounds, visuals and such.
* [[VoidExpanse/Content_modding|Content modding]] - adding new ships, weapons, items, or new quests, and basically extending the game content in some way.
* [[VoidExpanse/Scripting|Scripting]] - creating new mechanics that were not present in the original game.

{{Modding}}

VoidExpanse/modding

2015-04-15T11:36:57Z

Askew1: /* Package files */

== Overview ==
VoidExpanse is designed to have great modding potential. Almost every aspect of the game can be modified and extended.
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 the client and server.

== Package files ==
All game data is loaded from two types of files: ".cpk" and ".mpk"

===Core Package (CPK)===

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]]

== 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?

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.

== 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).
* 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.
* All file names are not case-sensitive. QwEr.xml and qwer.xml are considered the same.

== Mods header structure ==
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.

The structure of the "header.xml" is:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<id>unique_mod_id</id>
<title>Name of the mod</title>
<author>Author name</author>
<description>Brief description for the mod.</description>
<version>1.0.0</version> 
<updated>01.01.2015</updated> 
<modtype>2</modtype> 
</root>
</pre>
All these elements are mandatory for a mod and must be properly specified.

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 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.

{{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 ==
Now, the modding itself consists of a few essential parts:
* [[VoidExpanse/Assets_modding|Assets modding]] - where you can add or change graphics, sounds, visuals and such.
* [[VoidExpanse/Content_modding|Content modding]] - adding new ships, weapons, items, or new quests, and basically extending the game content in some way.
* [[VoidExpanse/Scripting|Scripting]] - creating new mechanics that were not present in the original game.

{{Modding}}

VoidExpanse/installing mods

2015-04-15T11:25:55Z

Askew1: Fix link to modding article.

== Mod files ==
This article mainly explains how to use already existing mods. If you are interested in creating mods please see: [[VoidExpanse/modding|VoidExpanse Modding]].

There are two kinds of mod files: *.CPK and *.MPK.

'''CPK''' - stands for Core Package. It contains essential game functionality, and without it game won't work. There shouldn't be multiple CPK files loaded at the same time as it can cause galaxy-scale disasters (not really).

'''MPK''' - stands for Mod Package. It contains all additional files that a mod adds.

== Using mods ==
'''STEAM and NON-STEAM versions'''

To install the mod, just drop it at the folder /Documents/AtomicTorchStudio/VoidExpanse/Mods
Then open "Mods" menu from the main menu in the game and mark the mod as active, click on a little checkbox near the mod icon.
Then click "Save" - mods configuration will be saved and the mods will be validated.

'''STEAM version only'''

In the Steam version you can install mods by subscribing on them in Steam Workshop - http://steamcommunity.com/app/324260/workshop

== ModsConfig.xml ==
To determine what mods should be loaded there is "ModsConfig.xml" file. It is usually located in the documents folder (''documents/AtomicTorchStudio/VoidExpanse'') and contains a list of mods that will be loaded the next time you start the game. Usually you don't have to edit this file by hands, but for the sake of completeness here is its structure:

<pre>
<mod>core_1.0.0</mod>
<mod>some_awesome_mod_0.5.9</mod>
</pre>

As you can see each mod specified as it's internal ID and it's version.

{{Modding}}

VoidExpanse/modding

2015-04-12T10:47:25Z

Askew1: /* Overview */

== Overview ==
VoidExpanse is designed to have great modding potential. Almost every aspect of the game can be modified and extended.
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 the client and server.

== Package files ==
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.

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.

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

== 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?

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.

== 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).
* 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.
* All file names are not case-sensitive. QwEr.xml and qwer.xml are considered the same.

== Mods header structure ==
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.

The structure of the "header.xml" is:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<id>unique_mod_id</id>
<title>Name of the mod</title>
<author>Author name</author>
<description>Brief description for the mod.</description>
<version>1.0.0</version> 
<updated>01.01.2015</updated> 
<modtype>2</modtype> 
</root>
</pre>
All these elements are mandatory for a mod and must be properly specified.

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 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.

{{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 ==
Now, the modding itself consists of a few essential parts:
* [[VoidExpanse/Assets_modding|Assets modding]] - where you can add or change graphics, sounds, visuals and such.
* [[VoidExpanse/Content_modding|Content modding]] - adding new ships, weapons, items, or new quests, and basically extending the game content in some way.
* [[VoidExpanse/Scripting|Scripting]] - creating new mechanics that were not present in the original game.

{{Modding}}