Commit 51d0d174 authored by Ryan Grupp's avatar Ryan Grupp
Browse files

Update Documentation

parent 49047c4e
......@@ -4,7 +4,7 @@ TSM is a group of script modules I've created for mission makers, but things tha
Functions with _(Editor safe.)_ in their description are safe to run on all clients via an init box in 3DEN.
[[_TOC_]]
[[_TOC_]]
<br>
<br>
......@@ -13,26 +13,17 @@ Functions with _(Editor safe.)_ in their description are safe to run on all clie
To start, download this repo and move the `tsm` folder into the root of your mission. So if you mission is called `my_mission.takistan` the path should look like `my_mission.takistan/tsm`.
Next, copy the `tsm_configuration.hpp` file from the `tsm` folder and paste it into the root of your mission folder, it should look something like `my_mission.takistan/tsm_configuration.hpp`.
Then open or create a `description.ext` file (you should already have one if you're using framework) and add the following at the bottom:
```
#include "tsm\_core_\xeh.hpp"
```
<br>
<br>
## Using TSM Configuration
__This step is only necessary if you plan to use a module that has a global configuration, and you need to modify that configuration.__ To start, copy the `tsm_configuration.hpp` file from the `tsm` folder and paste it into the root of your mission folder, it should look something like `my_mission.takistan/tsm_configuration.hpp`.
Next open your `description.ext` file, and add the following line under the tsm include:
```
#include "tsm_configuration.hpp"
```
You're now free to make edits to this file however you wish. __Note: Do not edit the file in the `tsm` folder as it may be overwritten by updates!__
__Note: Do not edit the `tsm_configuration.hpp` in the `tsm` folder as it may be overwritten by updates!__
<br>
<br>
......@@ -70,6 +61,25 @@ You're now free to make edits to this file however you wish. __Note: Do not edit
The \_core\_ module is the heart of TSM, there is no configuration involved, nor should the user touch it. It must exist for TSM to work.
<dl>
<dd><h4>Config Reference</h4></dd>
<dd>
<details>
<summary><strong>tsm_configuration.hpp</strong></summary>
| __Config Setting__ | __Type__ | __Description__ |
| ------------------ | -------- | --------------- |
| modules | Array | An array of modules to be loaded from TSM, you should remove the ones that you don't want to use from the list. |
<br>
<br>
</details>
</dd>
</dl>
<dl>
<dd><h4>Function Reference</h4></dd>
<dd>
......@@ -104,10 +114,9 @@ Arguments:
### Module - Ambient Sounds
_This module requires the use of [TSM Configuration](#using-tsm-configuration)._
_This module requires the use of TSM Configuration._
Ambient Sounds plays audio in the background to make your players more _immersed_. _It plays the sound (sfx) audio channel, ie. not music._
......@@ -202,7 +211,7 @@ CBRN module adds NBC threats to the mission, and ways for player to protect them
### Module - Combat Feedback
_This module requires the use of [TSM Configuration](#using-tsm-configuration)._
_This module requires the use of TSM Configuration._
Combat Feedback creates temporary markers on unit death.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment