Arma3_Epoch/ACE3
1
0
Fork 0
mirror of https://github.com/acemod/ACE3.git synced 2024-08-30 18:23:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1286 from acemod/SettingsDocumentationOverhaul

Browse Source 
overhaul settings.md
This commit is contained in:
bux578 2015-05-18 10:38:48 +02:00
commit 116bff9c1d
1 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
documentation/framework/settings.md
View File

@ -52,37 +52,44 @@ Settings are defined from the mods config but can be adjusted through the follow
The load order for the settings are:
* 1. Mod Config
* 2. Server Config
* 1. Mod config
* 2. Server config
* 3. Mission config
* 4. Placed down mission modules
What this means is that at any the 3 points after the mod config it is possible to insert your adjusted settings and force those (optionally). This is a powerful tool for server admins, whom can ensure that everyone is using uniform settings across the board on their server. And it provides mission makers the ability to easily set settings for their mission, without creating a large dependancy on ACE; you do not have to place down mission modules.
What this means is that at any the 3 points after the mod config it is possible to insert your adjusted settings and force those (optionally). This is a powerful tool for server admins, whom can ensure that everyone is using uniform settings across the board on their server. And it provides mission makers the ability to easily set settings for their mission, without creating a large dependency on ACE3; you do not have to place down mission modules.
## 3. How do I use them?
In the 'how do they work' chapter an example of settings was shown. This is the same for any settings config. The only difference is the location. For ACE3 modules, the settings are placed in the class `ACE_settings`. The same goes for the mission config.
The server config setting entries are done through our optional ACE_server.pbo, which can be found in the optionals folder of @ace. It also contains a userconfig folder, which inside contains the file ace\serverconfig.hpp. This is the location ACE3 settings are placed. There is no need for a sub class.
The server config setting entries are done through our optional ACE_server.pbo, which can be found in the optionals folder of @ace. It also contains a `userconfig` folder, which inside contains the file `ace\serverconfig.hpp`. This is the location ACE3 settings are placed. There is no need for a sub class.
### 3.1 Getting all the settings!
ACE3 contains a lot of settings; to tweak everything to your liking manually therefor can be quite a task. We have provided the option to export all settings in single player. For this, follow these simple steps:
ACE3 contains a lot of settings; for that reason tweaking everything to your liking manually can be quite a task. We have provided the option to export all settings in the editor (single-player). For this, follow these simple steps:
* Open the editor (Singleplayer).
* Open the editor (single-player).
* Under modules (<kbd>F7</kbd>), find ACE, `Config Export [ACE]`.
* Place down the module, ensure that the allow parameter is set to yes.
* Press preview, once in game, press Esc and open the ACE3 Options dialog (top left)
* This is the dialog where you can modify client side settings. On the bottom left of it, you will now see a button called 'Config Export'. Press it and a new dialog opens.
* You are now in the dialog that allows you to adjust all settings from ACE. Tweak this to your liking.
* Once you are done tweaking, press the 'Export' button and all settings will be copied to your clipboard.
* Paste the settings in your serverconfig.hpp file and done.
* Press preview, once in game, press <kbd>Esc</kbd> and open the ACE3 Options dialog (top left)
* This is the dialog where you can modify client side settings. On the bottom left of it, you will now see a button called `Config Export`. Press it and a new dialog opens.
* You are now in the dialog that allows you to adjust all settings from ACE3. Tweak this to your liking.
* Once you are done tweaking, press the `Export` button and all settings will be copied to your clipboard.
* Paste the settings in your `serverconfig.hpp` file and you're done.
Note that the format copied to your clipboard by this can also be used in the mission config, as long as they are in the class `ACE_Settings`.
Note that the format copied to your clipboard by this can also be used in the mission config (`description.ext`), as long as they are in the class `ACE_Settings`.
### 3.2 Loading up the serverconfig
```c++
class ACE_Settings {
// add exported settings here
};
```
As stated before, the serverconfig gets loaded through the optional ACE_server.pbo. This pbo is only required (and should only be used on) the server - clients do not need to have this! It is for this reason we have not signed this pbo.
Load the ACE_server.pbo like any other addon you do on your server. Advised is to create an @aceServer mod folder and load that through `-serverMod=@aceServer`.
### 3.2 Loading up the server config
As stated before, the server config gets loaded through the optional `ACE_server.pbo`. This PBO is only required (and should only be used) on the server - clients do not need to have this! It is for this reason we have not signed this PBO.
Load the `ACE_server.pbo` like any other addon on your server. It is advised to create an `@aceServer` mod folder with an `addons` sub folder where you would paste the `ACE_server.pbo` and load that through `-serverMod=@aceServer`.