mirror of
https://github.com/acemod/ACE3.git
synced 2024-08-30 18:23:18 +00:00
Document module dependencies
Add a list of dependencies to each module's documentation. Also add a note to the documenation of modules which are a dependency for many other modules. Dependency lists are pulled from each module's config.cpp.
This commit is contained in:
parent
be09a5cecd
commit
aa0940e180
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_ballistics`, `ace_weather`, `ace_modules`
|
||||
|
@ -24,4 +24,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -22,4 +22,4 @@ Adds a laser marker to the copilot seat of the Wildcat.
|
||||
Adds a HUD to the AH-9 based on the comanches HUD.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_main`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`, `ace_weather`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
@ -13,4 +13,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -25,4 +25,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -17,4 +17,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
13
documentation/feature/common.md
Normal file
13
documentation/feature/common.md
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
layout: wiki
|
||||
title: Common
|
||||
group: feature
|
||||
parent: wiki
|
||||
---
|
||||
# Overview
|
||||
Module that provides common features required by many other modules.
|
||||
|
||||
# Dependencies
|
||||
`ace_main`
|
||||
|
||||
Note: The Common module is required by many other modules. Disabling it is not recommended.
|
@ -13,4 +13,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
@ -13,4 +13,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
@ -17,4 +17,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
@ -18,4 +18,4 @@ To engage moving targets, place the crosshair on the enemy vehicle and press and
|
||||
To use manual lasing, place the crosshair on the object to range and press and hold tab.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -17,4 +17,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -16,4 +16,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,6 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
||||
Note: The Interact Menu module is required by many other modules. Disabling it is not recommended.
|
||||
|
@ -15,4 +15,6 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interact_menu`
|
||||
|
||||
Note: The Interaction module is required by many other modules. Disabling it is not recommended.
|
||||
|
@ -13,4 +13,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
@ -25,4 +25,4 @@ Steps to lock titan/Javelin:
|
||||
CTRL+TAB is default key to change firemode (configurable as a key)
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_main`, `ace_common`, `ace_missileguidance`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`, `ace_weather`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_laser`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
13
documentation/feature/main.md
Normal file
13
documentation/feature/main.md
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
layout: wiki
|
||||
title: Main
|
||||
group: feature
|
||||
parent: wiki
|
||||
---
|
||||
# Overview
|
||||
Main module which acts as the ACE core module.
|
||||
|
||||
# Dependencies
|
||||
Arma 3 and CBA
|
||||
|
||||
Note: Note: The Common module is required by all other modules. Do not disable it!
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
@ -13,4 +13,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -68,3 +68,6 @@ Morphine is used to alleviate large amounts of pain. Has an effect similar to He
|
||||
Epinephrine is used to increase heart rate and blood pressure and alleviate unconsciousness. Epinephrine is a synthetic form of Adrenaline, which is naturally produced in the body. It can also be applied to counter-act the effects of Atropine. Be careful though, as it may only be given once.
|
||||
|
||||
_Epinephrine must never be given to a casualty with a high heart rate or blood pressure._
|
||||
|
||||
# Dependencies
|
||||
`ace_interaction`, `ace_modules`, `ace_apl`
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_laser`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
@ -21,4 +21,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -13,4 +13,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
@ -20,4 +20,4 @@ Enables the user to manually adjust NVG brightness.
|
||||
Use Alt+PageUp and Alt+PageDown to adjust NVG brightness.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -14,4 +14,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,6 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
||||
Note: The Options Menu module is utilized by many other modules. Disabling it is not recommended.
|
||||
|
@ -24,4 +24,4 @@ To clear a jammed weapon, press Shift+R.
|
||||
*needs documentation on swapping barrels*
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
18
documentation/feature/overpressure.md
Normal file
18
documentation/feature/overpressure.md
Normal file
@ -0,0 +1,18 @@
|
||||
---
|
||||
layout: wiki
|
||||
title: Overpressure
|
||||
group: feature
|
||||
parent: wiki
|
||||
---
|
||||
# Overview
|
||||
## Sub-feature 1
|
||||
Short description of sub-feature 1.
|
||||
## Sub-feature 2
|
||||
Short description of sub-feature 2.
|
||||
|
||||
# Usage
|
||||
Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
`ace_common`
|
@ -19,4 +19,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -13,4 +13,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -14,4 +14,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -17,4 +17,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -13,4 +13,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
@ -15,5 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
r
|
||||
`ace_interaction`
|
||||
|
@ -17,4 +17,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -13,4 +13,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -13,4 +13,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -17,4 +17,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -13,4 +13,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -13,4 +13,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_interaction`
|
||||
|
@ -29,4 +29,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -21,4 +21,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`
|
||||
|
@ -15,4 +15,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_common`, `ace_modules`
|
||||
|
@ -13,4 +13,4 @@ Short overview of how to use the feature, e.g. menu options, key bindings,
|
||||
instructions. May not apply to all modules.
|
||||
|
||||
# Dependencies
|
||||
List of modules that must be present for this module to work.
|
||||
`ace_weather`
|
||||
|
Loading…
Reference in New Issue
Block a user