diff --git a/documentation/feature/advanced_ballistics.md b/documentation/feature/advanced_ballistics.md index d84f2b69b2..f50f6fcd8b 100644 --- a/documentation/feature/advanced_ballistics.md +++ b/documentation/feature/advanced_ballistics.md @@ -23,9 +23,9 @@ The Advanced Ballistics module improves internal and external ballistics. - A protractor for quickly measuring the inclination angle. ## 3. Usage + +### 3.1 Protractor Press Ctrl+Shift+K while using a compatible weapon to toggle the protractor. The red line indicates the current inclination angle in degrees. The protractor will disappear if you lower or holster your weapon. -This module uses relatively complex scripting. Several options are provided in the ACE menu to reduce the performance impact of this module. - -## Dependencies +## 4. Dependencies `ace_ballistics`, `ace_weather`, `ace_modules` diff --git a/documentation/feature/ai.md b/documentation/feature/ai.md index 00ef799531..a5deb17bdc 100644 --- a/documentation/feature/ai.md +++ b/documentation/feature/ai.md @@ -25,7 +25,6 @@ Some weapons had minimum engagement ranges. If you were as close as 2 meters to ### 1.5 No scripting All changes of ACE3 AI are config based to ensure full compatibility with advanced AI modifications like ASR AI. - ## 2. Dependencies `ace_common` diff --git a/documentation/feature/aircraft.md b/documentation/feature/aircraft.md index 7519c5c130..cb0ddb9c5f 100644 --- a/documentation/feature/aircraft.md +++ b/documentation/feature/aircraft.md @@ -32,12 +32,10 @@ Adds a laser marker to the copilot seat of the Wildcat. ### 1.7 HUD for AH-9 Adds a HUD to the AH-9 based on the Comanche's HUD. - ## 2. Usage ### 2.1 Switching flare modes -- ctrl+c (by default) - +Press Ctrl+C to switch between flare firing modes ## 3. Dependencies diff --git a/documentation/feature/attach.md b/documentation/feature/attach.md index 22820f1e7a..90bb33d585 100644 --- a/documentation/feature/attach.md +++ b/documentation/feature/attach.md @@ -11,27 +11,24 @@ parent: wiki ### 1.1 Attach items to uniform Allows players to attach IR grenades and chemlights to themselves. - ### 1.2 IR Strobe Adds an attachable IR strobe, which is only visible using night vision devices and offers better visibility than IR grenades. - ## 2. Usage ### 2.1 Attaching to yourself -- Self interact left windows . -- Choose `equipment`. -- Choose `attach item`. +- Use Self Interact Ctrl+Left Windows. +- Choose `Equipment`. +- Choose `Attach item`. - Select which item you want to attach. - Repeat to detach. -### 2.2 attaching to a vehicle -- Interact with the vehicle ctrl+left windows . -- Choose `attach item`. +### 2.2 Attaching to a vehicle +- Interact with the vehicle Left Windows. +- Choose `Attach item`. - Select your item and follow the instructions on the screen. - Repeat to detach. - ## 3. Dependencies `ace_interaction` diff --git a/documentation/feature/backpacks.md b/documentation/feature/backpacks.md index 9fcfce6b3b..aa803c2e3c 100644 --- a/documentation/feature/backpacks.md +++ b/documentation/feature/backpacks.md @@ -9,7 +9,7 @@ parent: wiki ## 1. Overview ### 1.1 Zipping sounds -A zipper sound rings out when someone tries to open your backpack. This helps to prevent banana theft. +A zipper sound is played when someone opens your backpack. This helps prevent banana theft. ## 2. Dependencies diff --git a/documentation/feature/ballistics.md b/documentation/feature/ballistics.md index 6df71050ff..3d82da9bc7 100644 --- a/documentation/feature/ballistics.md +++ b/documentation/feature/ballistics.md @@ -19,20 +19,19 @@ Decreases protection values of vests, CSAT uniforms and various campaign only ge Silencers no longer decrease the muzzle velocity and are generally less effective when used with normal ammunition. They now only remove the muzzle blast and flash. To prevent the crack caused by supersonic projectiles, ACE3 introduces subsonic ammunition for the 7.62mm caliber. This is also fully compatible with AI. ### 1.4 Flash suppressors -Flash suppressors are similar to sound suppressors and prevent the muzzle flash from reducing visibility without decreasing combat effectiveness. Flash suppressors are available for the calibers 5.56mm, 6.5mm, 7.62mm, .45 ACP and 9mm. +Flash suppressors are devices that reduce the muzzle flash while firing by cooling or dispersing the burning gases that exit the muzzle. Its intent is to reduce the chances that the shooter will be blinded in low-light shooting conditions as well as reducing the intensity of the flash visible to the enemy. -### 1.5 Armour piercing ammunition -Armour piercing rounds have higher penetration values against light armoured targets and other obstacles on the battlefield. Their drawback is a slightly decreased man-stopping power. AP rounds are available in multiple calibers incudling 5.56mm and 7.62mm. +### 1.5 Armor piercing ammunition +Armor piercing rounds have higher penetration values against light armored targets and other obstacles on the battlefield. Their drawback is a slightly decreased man-stopping power. AP rounds are available in multiple calibers incudling 5.56mm and 7.62mm. ### 1.6 IR-Dim tracer ammunition -IR-Dim ammunition is similar to tracer rounds, but their tracers are only visible using night vision devices. +IR-Dim ammunition is similar to tracer rounds, but these tracers are only visible using night vision devices. ### 1.7 M118 long range ammunition The M14 EBR now uses ammunition with decreased muzzle velocity and air friction to improve precision and energy retention at long ranges. ### 1.8 Fully config-based -This module uses configuration changes only and does not decrease game performance. - +This module applies configuration changes only and does not decrease game performance. ## 2. Dependencies diff --git a/documentation/feature/captives.md b/documentation/feature/captives.md index af68e2af1e..14395e62a1 100644 --- a/documentation/feature/captives.md +++ b/documentation/feature/captives.md @@ -9,7 +9,7 @@ parent: wiki ## 1. Overview ### 1.1 Take captives -Introduces a captivity system for taking and moving prisoners. +Introduces a captivity system. ### 1.2 Load and unload captives into / from vehicles You can load and unload captives from vehicles using ACE3 interactions. @@ -20,25 +20,24 @@ You can frisk a restrained captive. ### 1.4 Surrendering You can surrender. While surrendering AI will cease fire. - ## 2. Usage -### 2.1 Capturing someone -- You need `cable ties`. -- Approach the victim / convict and use the interaction button left windows (by default). -- The interaction is around the hands in the form of a handcuffs icon. -- To free someone simply use that icon again. +### 2.1 Taking a unit into captivity +- You need `Cable Tie`. +- Approach the unit and Interact Left Windows. +- The interaction is located around the hands in the form of a handcuffs icon. +- Repeat to release. ### 2.2 Escorting a captive -- Interact with the captive left windows (by default). -- Select the escort prisoner option. -- To stop escorting just scroll down and select `release` or use self interaction ctrl+left windows (by default) and select `release`. +- Interact with the captive Left Windows. +- Select the `Escort prisoner` option. +- To stop escorting, use the mousewheel and select `Release` or use Self Interaction Ctrl+Left windows and select `Release`. ### 2.3 Loading and unloading a captive into/from a vehicle -- Escort the person. -- Approach the vehicle you desire to load the captive in. -- Interact with the vehicle left windows (by default) and load him. -- Same for unloading, interact with the vehicle then unload. +- Escort the captive. +- Approach the vehicle you wish to load the captive unit into. +- Interact with the vehicle Left Windows and select `Load captive`. +- Interact with the vehicle to unload. ## 3. Dependencies diff --git a/documentation/feature/common.md b/documentation/feature/common.md index 6a1dba0aa1..d15cad3573 100644 --- a/documentation/feature/common.md +++ b/documentation/feature/common.md @@ -1,18 +1,15 @@ --- layout: wiki title: Common -description: +description: Common functions and systems used by most other components. group: feature parent: wiki --- -## Overview +## 1. Overview -Module that provides common features required by many other modules. +Common functions and systems used by most other components. - -## Dependencies +## 2. Dependencies `ace_main` - -Note: The Common module is required by many other modules. Disabling it is not recommended. diff --git a/documentation/feature/difficulties.md b/documentation/feature/difficulties.md index 97bf5de4b4..cfb9c461fb 100644 --- a/documentation/feature/difficulties.md +++ b/documentation/feature/difficulties.md @@ -1,7 +1,7 @@ --- layout: wiki title: Difficulties -description: +description: Tweak to Vanilla hardest difficulty group: feature parent: wiki --- @@ -9,7 +9,7 @@ parent: wiki ## 1. Overview ### 1.1 Elite mode adjustments -Adjusts the default settings for the hardest difficulty to more closely resemble A2 settings. (No crosshair, stat screen, death messages...) +Adjusts the default settings of the hardest difficulty to better resemble A2 settings (no crosshair, stat screen, death messages). ## 2. Dependencies diff --git a/documentation/feature/disarming.md b/documentation/feature/disarming.md index ef9bb74c42..7feef4575a 100644 --- a/documentation/feature/disarming.md +++ b/documentation/feature/disarming.md @@ -8,15 +8,15 @@ parent: wiki ## 1. Overview -### 1.1 Searching someone -You can search the inventory and disarm someone that is unconscious or captive. - +### 1.1 Searching through a unit's inventory +You can search the inventory and disarm captured or unconscious units. ## 2. Usage -### 2.1 Disarming someone -- Interact with the person that is unconscious or captive ctrl+left windows . -- Select `open inventory`. +### 2.1 Searching and disarming +- Interact with the captured or unconscious unit Ctrl+Left Windows. +- Select `Open inventory`. +- Drag & Drop the items you wish to remove from the unit. ## 3. Dependencies diff --git a/documentation/feature/disposable.md b/documentation/feature/disposable.md index 5b79ae3481..c60ae729cf 100644 --- a/documentation/feature/disposable.md +++ b/documentation/feature/disposable.md @@ -1,15 +1,14 @@ --- layout: wiki title: Disposable -description: +description: Makes NLAW disposable and allows addons to do the same group: feature parent: wiki --- ## 1. Overview -### 1.1 NLAW disposable anti tank weapon -Makes the NLAW disposable and provides the tools for other addons to do the same. +The NLAW is shoulder fired and disposable, firing just once before being needed to be disposed of. This feature makes the NLAW disposable and provides the tools for other addons to do the same. ## 2. Dependencies diff --git a/documentation/feature/dragging.md b/documentation/feature/dragging.md index df699bbe8f..56928ff4a8 100644 --- a/documentation/feature/dragging.md +++ b/documentation/feature/dragging.md @@ -1,28 +1,22 @@ --- layout: wiki title: Dragging -description: +description: Adds the option to drag and carry units and objects group: feature parent: wiki --- ## 1. Overview -### 1.1 Dragging and carrying -This adds the option to drag or carry people or objects. +This adds the option to drag or carry units or objects. ## 2. Usage -### 2.1 Dragging / carrying a person -- You can only drag or carry an unconscious / injured person -- Interact with the person left windows (by default) -- Choose `drag`or `carry` -- To release someone scroll down and use `release` or self interact ctrl+left windows (by default) and `release` - -### 2.2 dragging / carrying an object -- Interact with the Object left windows (by default) -- Chose `drag`or `carry` -- To release an object scroll down and use `release` or self interact ctrl+left windows (by default) and `release` +### 2.1 Dragging / Carrying units and objects +- You can only drag or carry an unconscious unit. +- Interact with the unit or object Left Windows +- Choose `Drag` or `Carry` +- To release, use the mousewheel and select `Release` or use Self Interaction Ctrl+Left windows and select `Release`. ## 3. Dependencies diff --git a/documentation/feature/explosives.md b/documentation/feature/explosives.md index de3500a9d3..1fd02f9af1 100644 --- a/documentation/feature/explosives.md +++ b/documentation/feature/explosives.md @@ -1,7 +1,7 @@ --- layout: wiki title: Explosives -description: +description: Adds numerous improvements to using and handling explosives group: feature parent: wiki --- @@ -11,29 +11,29 @@ parent: wiki ### 1.1 Advanced explosives placement Enables more precise placement of explosives. -### 1.2 More trigger types +### 1.2 Numerous trigger types Offers different trigger types, like clackers and dead man switches. -### 1.3 Attack explosives to vehicles +### 1.3 Attach explosives to vehicles Enables attaching explosives to vehicles. ## 2. Usage ### 2.1 Placing explosives -- Use self interaction ctrl + left windows (by default) -- Navigate to `explosives` +- Use self interaction Ctrl+Left Windows +- Select `Explosives` - Choose your explosive type and follow the instructions on the screen ### 2.2 Arming and detonating explosives -- Interact with the explosive left windows (by default) +- Interact with the explosive Left Windows - Choose the arming method -- For clackers `self interact` -> `explosives` -> `detonate` +- For clackers use Self Interaction `Explosives` -> `Detonate` and choose the corresponding Firing Device ### 2.3 Defusing explosives -- A `defusal kit`is needed -- Interact with the explosive left windows (by default) -- Then choose `disarm` -- You are now free to pick it up. +- A `Defusal Kit` is required +- Interact with the explosive Left Windows +- Choose `Disarm` +- You are safe to pick it up after the action is complete. ## 3. Dependencies diff --git a/documentation/feature/smallarms.md b/documentation/feature/smallarms.md index bc346b9cb9..5897123f9a 100644 --- a/documentation/feature/smallarms.md +++ b/documentation/feature/smallarms.md @@ -1,29 +1,22 @@ --- layout: wiki title: Small Arms -description: +description: Various improvements to small arms group: feature parent: wiki --- -## Overview +## 1. Overview -### Magazine Names +### 1.1 Magazine Names Unifies the name formatting of magazines similar to Arma 2 standards. -### No tracers in non-tracer mags +### 1.2 No tracers in non-tracer mags Assault rifles no longer have tracer rounds in their non-tracer magazines. This doesn't effect the additional tracers in the last rounds of machine gun magazines. -### Real magazine round counts +### 1.3 Real magazine round counts All pistol and sub machine gun magazines now have adjusted capacaties to match their real life counterparts. - -## 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` diff --git a/documentation/missionmaker/modules.md b/documentation/missionmaker/modules.md index 9712977cd0..c3ac03ef2c 100644 --- a/documentation/missionmaker/modules.md +++ b/documentation/missionmaker/modules.md @@ -11,34 +11,37 @@ parent: wiki ### 1.1 Advanced Ballistics *Part of: ace_advanced_ballistics* -This module allows to enable advanced external- and internal ballistics. +This module allows enabling and configuring advanced ballistic simulations. **Settings:** 1. **Advanced Ballistics (Boolean)**
Enables advanced ballistics.
`Default value: No` -2. **Always Enabled For Snipers (Boolean)**
-Always enables advanced ballistics when high power optics are used.
+2. **Enabled For Snipers (Boolean)**
+Enables advanced ballistics for non local snipers (when using high power optics).
`Default value: Yes` -3. **Disabled In FullAuto Mode (Boolean)**
+3. **Enabled For Group Members (Boolean)**
+Enables advanced ballistics for non local group members.
+`Default value: No` +4. **Enabled For Everyone (Boolean)**
+Enables advanced ballistics for all non local players (enabling this feature may degrade performance during heavy firefights in multiplayer).
+`Default value: No` +5. **Disabled In FullAuto Mode (Boolean)**
Disables the advanced ballistics during full auto fire.
`Default value: No` -4. **Disabled For Non Local Players (Boolean)**
-Disables the advanced ballistics for bullets coming from other players (enable this if you encounter frame drops during heavy firefights in multiplayer).
-`Default value: Yes` -5. **Enable Ammo Temperature Simulation (Boolean)**
+6. **Enable Ammo Temperature Simulation (Boolean)**
Muzzle velocity varies with ammo temperature.
`Default value: Yes` -6. **Enable Barrel Length Simulation (Boolean)**
+7. **Enable Barrel Length Simulation (Boolean)**
Muzzle velocity varies with barrel length.
`Default value: Yes` -7. **Enable Bullet Trace Effect (Boolean)**
+8. **Enable Bullet Trace Effect (Boolean)**
Enables a bullet trace effect to high caliber bullets (only visible when looking through high power optics).
-8. **Simulation Interval (Number)**
+9. **Simulation Interval (Number)**
Defines the interval between every calculation step.
`Default value: 0.05` -9. **Simulation Radius (Number)**
+10. **Simulation Radius (Number)**
Defines the radius around the player (in meters) at which advanced ballistics are applied to projectiles.
`Default value: 3000`