Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation - Add dependencies page #8706

Merged
merged 10 commits into from
Dec 2, 2021
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
368 changes: 213 additions & 155 deletions docs/_includes/dependencies_list.md

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions docs/_layouts/wiki.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,13 @@ <h2 class="toc-header">Table of contents</h2>
<div id="toc"></div>
</div>
</div>
{% if page.component %}
<div class="row">
<div class="large-12 columns">
<p><a href="{{ site.url }}/wiki/development/dependencies.html#{{ page.title | slugify }}"><i class="fa fa-1 fa-chevron-right"></i>&nbsp;&nbsp;See dependencies</a></p>
</div>
</div>
{% endif %}
</aside>
<section class="medium-8 medium-pull-4 small-12 columns">
<h1>{{page.title}}</h1>
Expand Down
3 changes: 2 additions & 1 deletion docs/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ sitemap:
<changefreq>weekly</changefreq>
<priority>0.5</priority>
</url>
{% for curPage in site.pages | sort: "group" %}
{% assign pages_by_group = site.pages | sort: "group" %}
{% for curPage in pages_by_group %}
{% unless curPage.sitemap.exclude == "yes" %}
<url>
<loc>{{ site.productionUrl}}{{ curPage.url }}</loc>
Expand Down
31 changes: 31 additions & 0 deletions docs/wiki/development/dependencies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
layout: wiki
title: Dependencies
description: This page details each component and its dependencies.
group: development
parent: wiki
order: 0
---

This page details each component and the addons it requires.

## 1. Removing a component

Any component you wish to remove must also remove any component which depends on it.

**Example:**

To remove `ace_ai` you must also remove `ace_zeus`.

Because `ace_zeus` is being removed you must also remove any components that require `ace_zeus` which in this case would be `ace_intelitems`.

## 2. Dependencies

{% assign pages_by_title = site.pages | sort: "title" %}
{% for page in pages_by_title %}
{%- if page.group == 'feature' and page.component -%}
### {{ page.title }}
{% capture component %}{{ page.component }}{% endcapture %}
{% include dependencies_list.md component=component %}
Mike-MF marked this conversation as resolved.
Show resolved Hide resolved
{%- endif -%}
{% endfor %}
6 changes: 1 addition & 5 deletions docs/wiki/feature/advanced-ballistics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: Advanced Ballistics
component: advanced_ballistics
description: The advanced ballistics module improves internal and external ballistics.
group: feature
category: realism
Expand Down Expand Up @@ -50,8 +51,3 @@ The Advanced Ballistics module improves internal and external ballistics.
- Press <kbd>Ctrl</kbd>+<kbd>⇧&nbsp;Shift</kbd>+<kbd>K</kbd>.
- Red line indicates the current inclination angle in degrees.
- Protractor will disappear if you lower or holster your weapon.


## 3. Dependencies

{% include dependencies_list.md component="advanced_ballistics" %}
7 changes: 1 addition & 6 deletions docs/wiki/feature/advanced-fatigue.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: Advanced Fatigue
component: advanced_fatigue
description: Human fatigue simulation based on scientific formulas.
group: feature
category: realism
Expand Down Expand Up @@ -91,9 +92,3 @@ At any time the body consumes a certain amount of ATP - even when not moving. Si
### 2.4 ATP Pathway Fatigue

Another factor that comes into play here is pathway fatigue - the pathways themselves can fatigue too! That means, the more ATP the pathways have to provide, the slower they will will be able to, limiting how much ATP can overall be provided by each pathway. If we take into account that the aerobic pathways have provide their ATP first for any consumption, that means that the anaerobic pathway will have to provide more ATP if the aerobic ones are fatigued. This is how the long term fatigue effect is created.



## 3. Dependencies

{% include dependencies_list.md component="advanced_fatigue" %}
6 changes: 1 addition & 5 deletions docs/wiki/feature/advanced-throwing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: Advanced Throwing
component: advanced_throwing
description: Precise system for throwing grenades and other throwable items.
group: feature
category: interaction
Expand Down Expand Up @@ -72,8 +73,3 @@ Make sure to use different keybinds for Advanced Throwing or unbind vanilla thro
- Interact with the item <kbd>⊞&nbsp;Win</kbd> (ACE3 default).
- Select `Pick Up`.
- Item will be placed in your hands, but you may not cancel the throw.


## 3. Dependencies

{% include dependencies_list.md component="advanced_throwing" %}
5 changes: 1 addition & 4 deletions docs/wiki/feature/ai.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: AI (Artificial Intelligence)
component: ai
description: Config based changes to AI to ensure compatibility with advanced AI modifications.
group: feature
category: realism
Expand Down Expand Up @@ -29,7 +30,3 @@ Some weapons had minimum engagement ranges. If you were as close as 2 meters to

### 1.4 No scripting
All changes of ACE3 AI are config based to ensure full compatibility with advanced AI modifications like e.g. "ASR AI 3".

## 2. Dependencies

{% include dependencies_list.md component="ai" %}
5 changes: 1 addition & 4 deletions docs/wiki/feature/aircraft.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: Aircraft
component: aircraft
description: Aircraft overhaul.
group: feature
category: realism
Expand Down Expand Up @@ -38,7 +39,3 @@ Adds a laser marker to the copilot seat of the Wildcat.

### 2.1 Switching flare modes
Press <kbd>Ctrl</kbd>+<kbd>C</kbd> to switch between flare firing modes (Arma 3 default key bind `countermeasure mode`)

## 3. Dependencies

{% include dependencies_list.md component="aircraft" %}
5 changes: 1 addition & 4 deletions docs/wiki/feature/apl.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: APL
component: apl
description: Assets under APL license.
group: feature
category: equipment
Expand All @@ -15,7 +16,3 @@ version:
## 1. Overview

This folder regroups all assets released under the APL license.

## 2. Dependencies

{% include dependencies_list.md component="apl" %}
4 changes: 1 addition & 3 deletions docs/wiki/feature/arsenal.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: ACE Arsenal
component: arsenal
description: Adds an interface that allow player to edit their loadouts.
group: feature
category: general
Expand Down Expand Up @@ -94,6 +95,3 @@ You can import loadouts from Virtual Arsenal into ACE Arsenal, face, voice, insi
- <kbd>RMB</kbd> clears the text field.
- Arrow keys can be used to move the caret.
- <kbd>Ctrl</kbd> + <kbd>F</kbd> switches which search bar is selected.


{% include dependencies_list.md component="arsenal" %}
6 changes: 1 addition & 5 deletions docs/wiki/feature/atragmx.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: ATragMX
component: atragmx
description: Handheld ballistics calculator.
group: feature
category: equipment
Expand Down Expand Up @@ -134,8 +135,3 @@ Horus ATragMX software considers atmospheric conditions, gun data, ammunition, r
## 4. Official References

- [Official Manual]({{ site.ace.githubUrl }}/blob/master/extras/manual_Horus_ATrag-v385.pdf)


## 5. Dependencies

{% include dependencies_list.md component="atragmx" %}
5 changes: 1 addition & 4 deletions docs/wiki/feature/attach.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: Attach
component: attach
description: Allow players to attach items to vehicles or themselves.
group: feature
category: interaction
Expand Down Expand Up @@ -34,7 +35,3 @@ Adds an attachable IR strobe, which is only visible using night vision devices a
- Select `Attach item`.
- Select your item and follow the instructions on the screen.
- Repeat the process to detach.

## 3. Dependencies

{% include dependencies_list.md component="attach" %}
5 changes: 1 addition & 4 deletions docs/wiki/feature/backpacks.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: Backpacks
component: backpacks
description: Notifies a player when his backpack is opened.
group: feature
category: equipment
Expand All @@ -16,7 +17,3 @@ version:

### 1.1 Zipping sounds
A zipper sound is played when someone opens your backpack.

## 2. Dependencies

{% include dependencies_list.md component="backpacks" %}
5 changes: 1 addition & 4 deletions docs/wiki/feature/ballistics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: Ballistics
component: ballistics
description: Realistic ballistic improvements.
group: feature
category: realism
Expand Down Expand Up @@ -31,7 +32,3 @@ The M14 EBR now uses ammunition with decreased muzzle velocity and air friction

### 1.6 Fully config-based
This module applies configuration changes only and does not decrease game performance.

## 2. Dependencies

{% include dependencies_list.md component="ballistics" %}
5 changes: 1 addition & 4 deletions docs/wiki/feature/captives.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: Captives
component: captives
description: System for taking and handling captives.
group: feature
category: interaction
Expand Down Expand Up @@ -47,7 +48,3 @@ Allows players to surrender. It renders the unit unable to move and with the han
- Select `Passengers`.
- Select the captive.
- Select `Unload captive`.

## 3. Dependencies

{% include dependencies_list.md component="captives" %}
5 changes: 1 addition & 4 deletions docs/wiki/feature/chemlights.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: Chemlights
component: chemlights
description: Adds enhanced types of chemlights.
group: feature
category: equipment
Expand All @@ -21,7 +22,3 @@ version:

### 1.1 Chemlights
Adds throwable chemlights in the colors white, red, green and yellow. Additionally "Hi" chemlights are added that emit a brighter glow.

## 2. Dependencies

{% include dependencies_list.md component="chemlights" %}
7 changes: 1 addition & 6 deletions docs/wiki/feature/common.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: Common
component: common
description: Common functions and systems used by most other components.
group: feature
category: general
Expand All @@ -15,9 +16,3 @@ version:
## 1. Overview

Common functions and systems used by most other components.

## 2. Dependencies

{% include dependencies_list.md component="common" %}

*Note: The Common module is required by nearly all other modules. Do NOT remove it!*
5 changes: 1 addition & 4 deletions docs/wiki/feature/concertina-wire.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: Concertina Wire
component: concertina_wire
description: Deployable concertina wire.
group: feature
category: equipment
Expand All @@ -22,7 +23,3 @@ A concertina wire is a type of barbed wire formed in large coils that can be exp
- Approach the concertina coil and select <kbd>⊞&nbsp;Win</kbd> (ACE3 default)
- Select `Deploy concertina wire`.
- Follow the instructions on screen.

## 3. Dependencies

{% include dependencies_list.md component="concertina_wire" %}
5 changes: 1 addition & 4 deletions docs/wiki/feature/crew-served-weapons.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: Crew Served Weapons
component: csw
description: Static weapons that require multiple people to crew
group: feature
category: equipment
Expand Down Expand Up @@ -72,7 +73,3 @@ Static weapons are assembled when a tripod is placed down, and the weapon mounte

- Whether or not you want to handle ammo using the CSW way. Does nothing if using defaultAssemblyMode
- Default: On

## 4. Dependencies

{% include dependencies_list.md component="csw" %}
5 changes: 1 addition & 4 deletions docs/wiki/feature/dagr.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: DAGR
component: dagr
description: Defense Advanced GPS Receiver.
group: feature
category: equipment
Expand All @@ -15,7 +16,3 @@ version:
## 1. Overview

Adds the Defense Advanced GPS Receiver.

## 3. Dependencies

{% include dependencies_list.md component="dagr" %}
5 changes: 1 addition & 4 deletions docs/wiki/feature/disarming.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: Disarming
component: disarming
description: Ability to make units drop items/weapons/magazines.
group: feature
category: interaction
Expand All @@ -23,7 +24,3 @@ You can search the inventory and disarm captured or unconscious units.
- Interact with the captured or unconscious unit <kbd>⊞&nbsp;Win</kbd> (ACE3 default key bind `Interaction Key`).
- Select `Open inventory`.
- Drag & Drop the items you wish to remove from the unit.

## 3. Dependencies

{% include dependencies_list.md component="disarming" %}
5 changes: 1 addition & 4 deletions docs/wiki/feature/disposable.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: Disposable
component: disposable
description: Makes NLAW disposable.
group: feature
category: equipment
Expand All @@ -15,7 +16,3 @@ version:
## 1. Overview

The NLAW is shoulder fired and disposable, firing just once before being needed to be disposed of. This feature makes the NLAW disposable.

## 2. Dependencies

{% include dependencies_list.md component="disposable" %}
5 changes: 1 addition & 4 deletions docs/wiki/feature/dragging.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: Dragging
component: dragging
description: Adds the option to drag and carry units and objects.
group: feature
category: interaction
Expand All @@ -23,7 +24,3 @@ This adds the option to drag or carry units or objects.
- Interact with the unit or object <kbd>⊞&nbsp;Win</kbd> (ACE3 default key bind `Interact Key`).
- Select `Drag` or `Carry`.
- To release, use the mouse wheel and select `Release` or use Self Interaction <kbd>Ctrl</kbd>+<kbd>⊞&nbsp;Win</kbd> and select `Release`.

## 3. Dependencies

{% include dependencies_list.md component="dragging" %}
5 changes: 1 addition & 4 deletions docs/wiki/feature/dragon.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: wiki
title: M47 Dragon Missile
component: dragon
description: M47 Dragon
group: feature
category: equipment
Expand Down Expand Up @@ -75,7 +76,3 @@ Adjust the sight picture by moving the launcher to align the vertical cross hair

**Figure 4. Range determination for frontal or rear target.**
<img src="{{ site.baseurl }}/img/wiki/feature/m47_frontal.webp" width="1400" height="357" alt="Frontal, Oblique, and Flank targets" />

## 4. Dependencies

{% include dependencies_list.md component="dragon" %}
Loading