Skip to content

Commit 801b1dc

Browse files
committed
Text/Formatting updates to README.md
1 parent 1302636 commit 801b1dc

File tree

1 file changed

+16
-24
lines changed

1 file changed

+16
-24
lines changed

README.md

+16-24
Original file line numberDiff line numberDiff line change
@@ -7,44 +7,36 @@
77

88
## Installation
99

10-
Download the latest version and unpack in your ARMA installation folder.
11-
For ARMA 3 content, launch with `-mod=@CBA_A3`
10+
Download the latest version and unpack it in your Arma 3 installation folder.
11+
Simply launch Arma 3 with `-mod=@CBA_A3` afterwards.
1212

1313
## Optionals
1414

15+
To install any of the optionals, simply copy the respective PBOs into the `@CBA_A3\addons` folder.
16+
1517
PBO | Description
1618
-------------------------------------- | --------------------------------------
17-
cba_cache_disable.pbo | Dev Tool. Copy this to your cba\addons if you want to disable CBA's caching of functions.
18-
cba_diagnostic_disable_xeh_logging.pbo | Copy this to your cba\addons if you want to disable all the extra RPT logging.
19-
cba_diagnostic_enable_logging.pbo | Dev Tool. Copy this to your cba\addons if you want to enable more logging.
20-
cba_enable_auto_xeh.pbo | This will add extended event handler (XEH) functionality to units and vehicles that are not XEH enabled. This may cause unforeseen side effects.
19+
cba_cache_disable.pbo | Disables CBA's function caching. (Dev Tool)
20+
cba_diagnostic_disable_xeh_logging.pbo | Disables all additional XEH RPT logging.
21+
cba_diagnostic_enable_logging.pbo | Enables additional logging (Dev Tool)
22+
cba_enable_auto_xeh.pbo | Automatically add Extended Event Handler functionality to units and vehicles that do not have XEH enabled. This might cause unpredictable behavior.
2123

2224
### CBA Caching
2325

24-
CBA implements a cache for all `compile preProcessFile`'d scripts (incl `CfgFunctions`, BIS functions module etc), and for all XEH events
25-
on `CfgVehicle` classes. This cache is stored in the `uiNamespace` and is therefore available throughout the whole lifetime of the running
26-
game (game start, till terminate game). Each class is only cached once, while mission and `campaignConfigfile` events are obviously
27-
evaluated every mission, but also only once per `CfgVehicle` class.
26+
CBA implements a cache for all `compile preProcessFile`'d scripts (incl `CfgFunctions`, BIS functions module, etc), and for all XEH events on `CfgVehicle` classes. This cache is stored in the `uiNamespace` and is therefore available throughout the whole lifetime of the running game (game start, till terminate game). Each class is only cached once, while mission and `campaignConfigfile` events are evaluated every mission, but also only once per `CfgVehicle` class.
2827

29-
The performance gains are seen in feature heavy mods like ACE or AGM which release on scripting to make their features possible.
30-
Some of these functions need a long time to initialize the game, switching missions, islands, going from editor back to the game,
31-
and so forth. 2nd-nth mission (re)starts go faster, but it is still nowhere near as fast as playing the Vanilla game.
28+
The performance gains are seen in feature rich mods like ACE3 which rely heavily on scripting to make their features possible.
29+
Some of these functionalities cause long loading times for the game, switching missions, islands and switching from the editor back to the game.
30+
After the first mission load functions will be cached and loading times for functions will be comparable with the vanilla game.
3231

33-
`cba_cache_disable.pbo` is an addon that can disable this if you need it however it makes mods slower by disabling CBA's function and
34-
script compilation cache, and xeh cache. It is useful during development so that edits will take effect without having to restart
35-
the game.
32+
`cba_cache_disable.pbo` is an optional addon that can disable this if you need it. However it makes mods slower by disabling CBA's function and script compilation cache, as well as the XEH cache. It is useful during development, since script changes will take effect without restarting the entire game.
3633

3734
## Known Issues
3835

39-
* CBA Keybinding requires a mission to be initialized to function properly. This includes working in the main menu of Arma 3. Command-line parameters like `-world=empty` or `-skipIntro` will cause Keybinding to work ONLY in-game but NOT in the main menu of Arma.
36+
* CBA Keybindings require a mission to be initialized to function properly. This includes working in the main menu of Arma 3. Commandline parameters like `-world=empty` or `-skipIntro` will cause Keybinding to work ONLY in-game but NOT in the main menu.
4037

4138
## License
4239

43-
Licensed under [GNU GENERAL PUBLIC LICENSE v2](license.txt)
40+
Licensed under GNU General Public License ([GPLv2](license.txt))
4441

45-
Any addon which calls CBA-defined functions need not be licensed under the GPLv2
46-
or released under a free software license. Only if you are directly including
47-
CBA code in your addon's binarized PBO or redistributing a modified version of
48-
CBA itself would your work be considered derivative and therefore be legally
49-
required to be released under the terms of the GPL. (And there's no reason to
50-
ever do either of these.)
42+
Any addon which calls CBA-defined functions need not be licensed under the GPLv2 or released under a free software license. Only if it is directly including CBA code in the addon's binarized PBO or redistributing a modified version of CBA itself would it be considered derivative and therefore be legally required to be released under the terms of the GPL. (And there's no reason to ever do either of these.)

0 commit comments

Comments
 (0)