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

Documentation pass 3

Browse Source 
- Fixed typos in laser/readme
- Documentation guidelines updated
- ACE3 mentions updated in
- - ai
- Updated doc
- - fcs
- - hearing
-  -hitreaction
- - interaction
- - interact_menu
- - inventory
- - javelin
- - laser
- - laserpointer
- - laser_selfdesignate
- - logistics_uavbattery
- - logistics_wirecutter
- - magazinerepack
- - main
- - map
- - maptools
- - markers
This commit is contained in:
Josuan Albin 2015-05-17 19:51:46 +02:00
parent 9e8283ebab
commit 836cd9d833
20 changed files with 162 additions and 196 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
addons/laser/README.md
View File

@ -1,7 +1,7 @@
ace_laser
=========
Contains various functions necessary for the realitic protrayal of laser mechanics in other components.
Contains various functions necessary for the realistic portrayal of laser mechanics in other components.
## Maintainers

2
documentation/development/Documentation guidelines and tips.md
View File

@ -42,6 +42,7 @@ Short description of sub-feature 2.
- Step 3.
## 3. Dependencies
`ace_something`
## 4. Guides
@ -50,6 +51,7 @@ Short description of sub-feature 2.
# Guidelines
- A line between each entry like above.
- Use `ACE3` instead of `ACE 3`.
- Remove each entry that is not used.
- Don't forget to say what you're going to work on in #documentation in slack or [this topic] (https://github.com/acemod/ACE3/issues/1166)
- Keybinds in ``` <kbd>thoses thingies</kbd> ```

4
documentation/feature/ai.md
View File

@ -20,10 +20,10 @@ AIs will now use the automatic mode of their weapons on short distances, instead
The maximum engagement ranges are increased: AI will fire in bursts with variable length on high ranges of 500 - 700 meters, depending on their weapon and optic.
### 1.4 No deadzones in CQB
Some weapons had minimum engagement ranges. If you were as close as 2 meters to an AAF soldier, he wouldn't open fire, because the AI couldn't find any valid fire mode for their weapon. ACE 3 removes this behaviour mostly notable in CQB by adding a valid firing mode.
Some weapons had minimum engagement ranges. If you were as close as 2 meters to an AAF soldier, he wouldn't open fire, because the AI couldn't find any valid fire mode for their weapon. ACE3 removes this behaviour mostly notable in CQB by adding a valid firing mode.
### 1.5 No scripting
All changes of ACE 3 AI are config based to ensure full compatibility with advanced AI modifications like ASR AI.
All changes of ACE3 AI are config based to ensure full compatibility with advanced AI modifications like ASR AI.
## 2. Dependencies

23
documentation/feature/fcs.md
View File

@ -6,25 +6,32 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Fire control system
### 1.1 Fire control system
Offers a custom fire control system for tanks and helicopters. It enables engaging stationary and moving targets.
### Manual lasing targets
### 1.2 Manual lasing targets
Changes the default rangefinders, including those in vehicles, to require manual lasing.
### Air burst ammunition
### 1.3 Air burst ammunition
Anti air cannons can now use airburst ammunition. It will explode on the FCS' zeroed in range.
## Usage
## 2. Usage
To engage moving targets, place the crosshair on the enemy vehicle and press and hold tab. Follow the moving target with your crosshair for about 2 seconds and release tab. The optic will now be adjusted sideways to ensure a hit.
### 2.1 Engaging moving targets
To use manual lasing, place the crosshair on the object to range and press and hold tab.
- Place the crosshair on the enemy vehicle.
- Press and hold <kbd> tab </kbd> (by default) and follow the target for about 2 seconds.
- Release <kbd> tab </kbd>
- The optic is now adjusted sideways to ensue a hit.
### 2.2 Ranging stationary targets
## Dependencies
- Place the crosshair on the object to range.
- Tap <kbd> tab </kbd> (by default) the optic is now adjusted.
## 3. Dependencies
`ace_interaction`

22
documentation/feature/hearing.md
View File

@ -6,22 +6,26 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Hearing damage simulation
### 1.1 Hearing damage simulation
Introduces hearing damage caused by nearby explosions and large-caliber weapons.
### Earplugs
### 1.2 Earplugs
Adds ear plugs to mitigate that effect. Soldiers with high caliber weapons or
missile launchers will be equipped with those, but remember to put them in.
## Usage
## 2. Usage
Short overview of how to use the feature, e.g. menu options, key bindings,
instructions. May not apply to all modules.
### 2.1 Equipping earplugs
- For this you obviously need `Ear plugs`.
- Press the self interaction key <kbd> ctrl+left windows </kbd> (by default).
- Select `equipment`.
- Select `Earplugs in`.
- Same method to remove them but the option is `Earplugs out`.
- Note that you CAN re-use ear plugs.
## 3. Dependencies
## Dependencies
`ace_interaction`
`ace_interaction`

19
documentation/feature/hitreactions.md
View File

@ -6,21 +6,12 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Sub-feature 1
Short description of sub-feature 1.
### 1.1 Falling under fire
If a unit is shot while running it falls to the ground in a prone position, the area where the shot lands does not matters.
Note that the shot needs to inflict a certain amout of damage to make the unit fall, a small cut won't make the unit stumble.
### 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
## 2. Dependencies
`ace_common`

17
documentation/feature/interact_menu.md
View File

@ -6,22 +6,11 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Sub-feature 1
Short description of sub-feature 1.
This handles the interaction layer of ACE3.
### 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
## 2. Dependencies
`ace_common`

17
documentation/feature/interaction.md
View File

@ -6,22 +6,11 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Sub-feature 1
Short description of sub-feature 1.
This provides interaction options between units.
### 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
## 2. Dependencies
`ace_interact_menu`

16
documentation/feature/inventory.md
View File

@ -6,18 +6,22 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Resized inventory UI
### 1.1 Resized inventory UI
Makes the inventory dialog bigger and increases the number of items that can be seen in the list at once.
## Usage
## 2. Usage
Short overview of how to use the feature, e.g. menu options, key bindings,
instructions. May not apply to all modules.
### 2.1 Changing the size of the UI
- Press <kbd> escape </kbd>.
- Click on `ACE OPTIONS` on the top left corner of the screen.
- Click on `Make Inventory Display Bigger`.
- Choose the size desired on the right drop down menu.
- Press the `Close` button, your changes are automatically saved.
## Dependencies
## 3. Dependencies
`ace_common`

35
documentation/feature/javelin.md
View File

@ -6,31 +6,30 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Sub-feature 1
Short description of sub-feature 1.
### 1.1 Improved locking
The locking capabilities of the Titan and Javelin got improved, you can now lock on anything that has a thermal signature, including houses.
### Sub-feature 2
Short description of sub-feature 2.
### 1.2 Fire mode switching
The Titan / Javelin now posses the ability to be used in top down attack or direct.
## Usage
## 2. Usage
Short overview of how to use the feature, e.g. menu options, key bindings,
instructions. May not apply to all modules.
### 2.1 Locking with the Titan / Javelin
- For this feature you need to have a compatible launcher.
- Fully zoom with the launcher.
- Switch to thermals <kbd> n </kbd> (by default).
- While keeping your aim steadily on target press and hold <kbd> tab </kbd>.
- When the sound changes and a cross appears on the screen it's time to fire.
Steps to lock titan/Javelin:
1. You must be zoomed ALL THE WAY IN
2. You must be in thermal view
3. You must have a missile loaded
4. Hold TAB over a target, it will start beeping and the constraint boxes will appear
5. Once the beeping changes to LOCK tone, and the lock crosshairs appear, click fire without releasing tab
CTRL+TAB is default key to change firemode (configurable as a key)
### 2.2 Switching fire mode
- For this feature you need to have a compatible launcher.
- When aiming with your launcher press <kbd> ctrl+tab </kbd> (by default).
- On the right side of the screen (for most launchers) you should see that `TOP`is now in green that means that your missile will be fired in top down mode.
## Dependencies
## 3. Dependencies
`ace_main`, `ace_common`, `ace_missileguidance`

17
documentation/feature/laser.md
View File

@ -6,21 +6,10 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Sub-feature 1
Short description of sub-feature 1.
Contains various functions necessary for the realistic portrayal of laser mechanics in other components.
### 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
## 2. Dependencies
`ace_common`

17
documentation/feature/laser_selfdesignate.md
View File

@ -6,21 +6,10 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Sub-feature 1
Short description of sub-feature 1.
Allows gunners to lase their own targets. See [FCS] (http://ace3mod.com/wiki/feature/fcs.html) for more information.
### 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
## 2. Dependencies
`ace_laser`

21
documentation/feature/laserpointer.md
View File

@ -6,21 +6,18 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Sub-feature 1
Short description of sub-feature 1.
### 1.1 Visible light laser
ACE3 adds visible light laser. This feature is compatible with BI's lasers as well as supported modded ones.
### Sub-feature 2
Short description of sub-feature 2.
## 2. Usage
### 2.1 Switching laser mode
- For this feature you need to have a compatible side attachment.
- Press <kbd> ctrl+L </kbd> (by default).
- A hint indicating the mode switch will appear in the top right corner.
## Usage
Short overview of how to use the feature, e.g. menu options, key bindings,
instructions. May not apply to all modules.
## Dependencies
## 3. Dependencies
`ace_common`

20
documentation/feature/logistics_uavbattery.md
View File

@ -6,21 +6,17 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Sub-feature 1
Short description of sub-feature 1.
### 1.1 Rechargeable darters.
Adds an item `ACE_UAVBattery` that allows refuelling/recharging of the "Darter" quadcopter UAVs.
### Sub-feature 2
Short description of sub-feature 2.
## 2. Usage
### 2.1 Recharging the darter
- For this you need a `UAV battery` and the UAV needs to be a quadcopter.
- INTERACTION LAYER NOT IMPLEMENTED YET TO BE COMPLETED.
## Usage
Short overview of how to use the feature, e.g. menu options, key bindings,
instructions. May not apply to all modules.
## Dependencies
## 3. Dependencies
`ace_interaction`

22
documentation/feature/logistics_wirecutter.md
View File

@ -6,21 +6,19 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Sub-feature 1
Short description of sub-feature 1.
### 1.1 Wirecutter
Adds an item `ACE_wirecutter` that allows cutting of fences in A3 and AiA maps.
### Sub-feature 2
Short description of sub-feature 2.
## 2. Usage
### 2.1 Using the wirecutter
- For this you need a `Wirecutter`.
- Approach the fence you want to cut.
- Press the interaction key <kbd> left windows </kbd> (by default).
- Find the interaction point and select `cut fence` (the only option).
## Usage
Short overview of how to use the feature, e.g. menu options, key bindings,
instructions. May not apply to all modules.
## Dependencies
## 3. Dependencies
`ace_interaction`

20
documentation/feature/magazinerepack.md
View File

@ -6,20 +6,20 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Repacking magazines
Adds ability to repack magazines of the same type. An optional module provides
options to adjust the repacking time of single rounds and whole magazines to
the mission maker.
### 1.1 Repacking magazines
Adds the ability to repack magazines of the same type.
## Usage
## 2. Usage
Short overview of how to use the feature, e.g. menu options, key bindings,
instructions. May not apply to all modules.
### 2.1 Repacking
- For this you need multiple half empty mags of the same type.
- Press the self interaction button <kbd> ctrl+left windows </kbd> (by default).
- Select `Repack magazines`.
- Select the type of magazines you want to repack.
## Dependencies
## 3. Dependencies
`ace_interaction`

8
documentation/feature/main.md
View File

@ -6,13 +6,13 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
Main module which acts as the ACE core module.
## Dependencies
## 2. Dependencies
Arma 3 and CBA
`Arma 3` and `CBA (RC6 minimum)`
Note: Note: The Main module is required by all other modules. Do not disable it!
Note: The Main module is required by all other modules. Do not disable it!

27
documentation/feature/map.md
View File

@ -6,21 +6,28 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Sub-feature 1
Short description of sub-feature 1.
### 1.1 Map styling
Better map styling (contours, legend, hiding bushes and trees, etc).
### Sub-feature 2
Short description of sub-feature 2.
### 1.2 Map zoom level (optional)
The mission maker / server owner can restrict the maximum zoom level of the map.
### 1.3 Map shake (optional)
While walking your map will move all around the place.
### 1.4 Map illumination (optional)
The map illumination will be the same as your surroundings meaning that in a dark night you'll either need a lightsource or NVGs to see your map.
### 1.5 Blufor tracker (optional)
With blufor tracker you'll never loose your leader anymore, it marks the position of your faction group leader on the map.
## Usage
## 2. Usage
Short overview of how to use the feature, e.g. menu options, key bindings,
instructions. May not apply to all modules.
- IMPORTANT NOTICE: The (optional) features above CAN be restricted by the mission maker / server owner. User experience may vary.
## Dependencies
## 3. Dependencies
`ace_interaction`

36
documentation/feature/maptools.md
View File

@ -6,21 +6,33 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Sub-feature 1
Short description of sub-feature 1.
### 1.1 Line drawing
This adds the possibility to draw accurate lines.
### Sub-feature 2
Short description of sub-feature 2.
### 1.2 Map tools
This adds map tools that can be used to measure distances between two points on the map or bearings.
### 1.3 GPS on map
If you are equipped with a vanilla GPS it will be shown on the map. (You don't need the map tools in your inventory for this.)
## 2. Usage
### 2.1 Using map tools
- For this you need to have `Map Tools`.
- Open the map <kbd> M </kbd> (by default).
- Press the self interaction key <kbd> ctrl+left windows </kbd> (by default).
- Select `Map tools`.
- Select the type of tools you want to use.
- Note that you can drag the Roamer (map tool) around with <kdd> LMB </kbd> and rotate it with <kbd> ctrl+LMB </kbd>.
### 2.2 Drawing lines
- To draw lines `Map Tools` are not required.
- Press <kbd> alt+left click </kbd> (by default) to start the line, left click again to end it.
- To delete a line simply press <kbd> delete </kbd> around the center of the line.
## Usage
Short overview of how to use the feature, e.g. menu options, key bindings,
instructions. May not apply to all modules.
## Dependencies
## 3. Dependencies
`ace_interaction`

13
documentation/feature/markers.md
View File

@ -6,18 +6,11 @@ group: feature
parent: wiki
---
## Overview
## 1. Overview
### Improved marker placement
### 1.1 Improved marker placement
Expands the "Insert Marker" menu and allows to rotate map markers. Shows the currently selected channel to prevent misplacement.
## Usage
Short overview of how to use the feature, e.g. menu options, key bindings,
instructions. May not apply to all modules.
## Dependencies
## 2. Dependencies
`ace_common`