Commit 3a51ce46 authored by Ryan Grupp's avatar Ryan Grupp 💀
Browse files

Readme test

parent afe5a700
......@@ -4,8 +4,8 @@ TSM is a group of script modules I've created for mission makers, but things tha
[[_TOC_]]
<br>
<br>
## How To Install
......@@ -17,6 +17,9 @@ Then open or create a `description.ext` file (you should already have one if you
#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`.
......@@ -29,6 +32,9 @@ Next open your `description.ext` file, and add the following line under the tsm
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!__
<br>
<br>
## Module Documenation
| __Module__ | __Has Global Configuration__ |
......@@ -70,25 +76,37 @@ Ambient Sounds plays audio in the background to make your players more _immersed
Car Radio allows a player in a vehicle _(doesn't actually need to be a car)_ to use ACE interact to play a song on the radio (or stop a playing one). _Plays in the music audio channel._
> #### __tsm_car_radio_fnc_init__
> Initialises a vehicle to have a radio.
>
> Arguments:
> * __Vehicle__ <sub>_(object)_</sub>
> * The vehicle to add a radio to.
> * __Songs__ <sub>_(array)_</sub>
> * A list of classnames from CfgMusic _(config or mission config)_ of songs to play.
>
> ```sqf
> [
> this,
> [
> "cbb_music_2_minutes_to_midnight_im",
> "cbb_music_bad_company_bc",
> "cbb_music_dont_fear_the_reaper_boc"
> ]
> ] call tsm_car_radio_fnc_init;
> ```
<dl>
<dd><h3>Function Reference</h3></dd>
<dd>
<details>
<summary><strong>tsm_car_radio_fnc_init</strong></summary>
Initialises a vehicle to have a radio.
Arguments:
* __Vehicle__ <sub>_(object)_</sub>
* The vehicle to add a radio to.
* __Songs__ <sub>_(array)_</sub>
* A list of classnames from CfgMusic _(config or mission config)_ of songs to play.
```sqf
[
this,
[
"cbb_music_2_minutes_to_midnight_im",
"cbb_music_bad_company_bc",
"cbb_music_dont_fear_the_reaper_boc"
]
] call tsm_car_radio_fnc_init;
```
<br>
<br>
</details>
</dd>
### Module - Components
......
Supports Markdown
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