Updated wiki docs. Renamed Liberation to Retribution on many pages.

MetalStormGhost 2023-06-19 14:01:35 +03:00
parent e4982660a0
commit 39240a745b
6 changed files with 26 additions and 26 deletions

@ -1,5 +1,5 @@
# Overview
Frontline movement in DCS: Liberation is based on the results of the running battle between ground units deployed out of the frontline's connected Control Points. The frontline can come no closer than 5km to an uncaptured Control Point at the start of a mission. The location of the frontline is based upon the relative Strength Ratings of the connected Control Points.
Frontline movement in DCS: Retribution is based on the results of the running battle between ground units deployed out of the frontline's connected Control Points. The frontline can come no closer than 5km to an uncaptured Control Point at the start of a mission. The location of the frontline is based upon the relative Strength Ratings of the connected Control Points.
# Base Strength
## Maximum and Minimum

@ -1,4 +1,4 @@
# How to get DCS Liberation?
# How to get DCS Retribution?
## Download:
You have two choices, either download a stable or a preview release:
@ -9,25 +9,25 @@ You have two choices, either download a stable or a preview release:
## Installation:
1. Extract the zip file to any directory other than Program Files and Program Files (x86). C:\Users\<Username>\Saved Games\ is a recommended location (it would look like C:\Users\<Username>\Saved Games\dcs_liberation\ when you're done). This _will be_ the install directory. It should preferably be a directory that's accessible without requiring Administrator privileges. Otherwise, in the shortcut's compatibility tab, select "Run this program as an administrator".
2. Then launch `liberation_main.exe` to launch DCS Liberation.
2. Then launch `liberation_main.exe` to launch DCS Retribution.
First launch splash screen
![DCS Liberation first launch screenshot](https://user-images.githubusercontent.com/67376231/140951014-5dab4087-35e5-404e-a4e5-007db927bdb6.png)
![DCS Retribution first launch screenshot](https://user-images.githubusercontent.com/67376231/140951014-5dab4087-35e5-404e-a4e5-007db927bdb6.png)
**Important Note before you launch DCS Liberation :**
**Important Note before you launch DCS Retribution :**
DCS Liberation will modify the following file in your DCS installation: `<DCS Installation Directory>/Scripts/MissionScripting.lua`. This allows Liberation to record information about mission events. This will **not** prevent you from passing the integrity check to join multiplayer servers.
DCS Retribution will modify the following file in your DCS installation: `<DCS Installation Directory>/Scripts/MissionScripting.lua`. This allows Retribution to record information about mission events. This will **not** prevent you from passing the integrity check to join multiplayer servers.
This file will be modified whenever DCS Liberation is opened and the original will be replaced when DCS Liberation is closed.
This file will be modified whenever DCS Retribution is opened and the original will be replaced when DCS Retribution is closed.
**You must always launch DCS Liberation before you launch DCS.**
**You must always launch DCS Retribution before you launch DCS.**
If you don't, DCS will load the file before it is changed and DCS Liberation will not be able to retrieve mission progress.
If you don't, DCS will load the file before it is changed and DCS Retribution will not be able to retrieve mission progress.
Experienced users can also disable the automatic modification of the `MissionScripting.lua`. This can be achieved by leaving the `DCS Installation Directory` preference empty.
**Warning**: If you leave the `DCS Installation Directory` empty, you have to manually edit the `MissionScripting.lua`. Otherwise DCS Liberation can not work properly. This is only recommended for expert users. A description on how to manually edit the file can be found in the [Dedicated-Server-Guide](https://github.com/dcs-retribution/dcs-retribution/wiki/Dedicated-Server-Guide#modding-missionscriptinglua).
**Warning**: If you leave the `DCS Installation Directory` empty, you have to manually edit the `MissionScripting.lua`. Otherwise DCS Retribution can not work properly. This is only recommended for expert users. A description on how to manually edit the file can be found in the [Dedicated-Server-Guide](https://github.com/dcs-retribution/dcs-retribution/wiki/Dedicated-Server-Guide#modding-missionscriptinglua).
#
# Start your first campaign
@ -81,7 +81,7 @@ Generator settings:
Mod settings:
* If you want any of these mods considered during your campaign generators, please select accordingly
* You are required to have the selected mods already installed and operational prior to DCS Liberation campaign generation
* You are required to have the selected mods already installed and operational prior to DCS Retribution campaign generation
#
### Difficulty and automation options

@ -44,7 +44,7 @@ This mission type is only available when the CTLD plugin is enabled as it is req
### Airlift (Transport)
An Airlift is a transport mission for a unit transfer and can be created from the Unit transfer dialog. It will also be automatically created for transfers if there is no other transport route (convoy, ship) available. To enforce an airlift the user has to choose Airlift as the requested transport type within the unit transfer dialog.
When the CTLD plugin is enabled liberation will automatically create the necessary pickup and drop off zones as well as a special logisitc unit which allows to spawn crates which can then be sling loaded. It is important to check the actual position of the Pickup and Drop off Waypoint as the CTLD zones will be placed at these locations. These zones will only be generated for player flights. The AI will not use the CTLD specific logic.
When the CTLD plugin is enabled Retribution will automatically create the necessary pickup and drop off zones as well as a special logisitc unit which allows to spawn crates which can then be sling loaded. It is important to check the actual position of the Pickup and Drop off Waypoint as the CTLD zones will be placed at these locations. These zones will only be generated for player flights. The AI will not use the CTLD specific logic.
### Anti-ship

@ -2,7 +2,7 @@
Well, we could, but...
It takes a lot of time to add support for a mod in Liberation. We prefer using the free time we can allocate to Liberation to develop features that will benefit the whole community of Liberation users.
It takes a lot of time to add support for a mod in Retribution. We prefer using the free time we can allocate to Retribution to develop features that will benefit the whole community of Retribution users.
> I'm willing to support the mod in liberation myself!
@ -10,7 +10,7 @@ Here is how to do it:
## Pre-requisites:
* A development environment for DCS Liberation, see [Developer's Guide](Developer's-Guide)
* A development environment for DCS Retribution, see [Developer's Guide](Developer's-Guide)
* Basic Python programming knowledge
* Basic Lua programming knowledge
* A DCS World open beta installation
@ -19,7 +19,7 @@ Here is how to do it:
Adding support for a modded aircraft is much more complicated than adding its name in a faction file.
In order for a modded aircraft to work with Liberation, we need to generate a data export for it to work with [pydcs](https://github.com/pydcs/dcs)
In order for a modded aircraft to work with Retribution, we need to generate a data export for it to work with [pydcs](https://github.com/pydcs/dcs)
Pydcs is the library we use to generate the .miz files, it is awesome, but it is not magical and can't support modded content natively if we don't tell it how do to do it. Its database also need to be updated every time DCS is updated.
@ -61,7 +61,7 @@ These file contains a lot of metadata we need to be able to generate missions, s
## Step 2: Pydcs extensions injection:
Once you've created your extension, you need to inject it's content into the pydcs version run by Liberation. In the Python file you created for the mod, decorate each unit type with either `@planemod`, `@vehiclemod`, or `@helicoptermod`. For example:
Once you've created your extension, you need to inject it's content into the pydcs version run by Retribution. In the Python file you created for the mod, decorate each unit type with either `@planemod`, `@vehiclemod`, or `@helicoptermod`. For example:
```python
@ -141,9 +141,9 @@ For campaign start setup and mod settings support, add your plane to the files [
modLayout.addWidget(frenchpack, 6, 1)
```
## Step 3 : Liberation flight planner database setup:
## Step 3 : Retribution flight planner database setup:
### DCS Liberation 7
### DCS Retribution
The aircraft preferences per task are kept in each aircraft's yaml file in `resources/units/aircraft/*.yaml`. Each task is assigned a weight describing the aircraft's relative strength at the given task. Aircraft with a higher weight for a given task will be preferred over those with a lower weight. If a task is omitted from the yaml file, the aircraft will not be capable of performing that mission type. For example:
@ -184,11 +184,11 @@ tasks:
TARCAP: 460
```
The hornet has a BAI weight of 740 while the viper has a BAI weight of 750. Liberation will prefer choosing vipers to hornets when deciding which aircraft is better suited to BAI.
The hornet has a BAI weight of 740 while the viper has a BAI weight of 750. Retribution will prefer choosing vipers to hornets when deciding which aircraft is better suited to BAI.
Aircraft can have identical weights for a task. When multiple aircraft have the same weight for a task, they are treated as equal by Liberation. Selection criteria vary by many factors; one may be chosen randomly from the set of equal aircraft, one may be chosen arbitrarily, or a different but similar aircraft may be chosen. **These weights are only guidelines.** Use them to give Liberation hints about which aircraft are better at each task.
Aircraft can have identical weights for a task. When multiple aircraft have the same weight for a task, they are treated as equal by Retribution. Selection criteria vary by many factors; one may be chosen randomly from the set of equal aircraft, one may be chosen arbitrarily, or a different but similar aircraft may be chosen. **These weights are only guidelines.** Use them to give Retribution hints about which aircraft are better at each task.
For an overview of all tasks and weights in Liberation, run `dcs_liberation.exe dump-task-priorities` (from the command line). That will dump `Liberation/Debug/priorities.yaml` to your DCS Saved Games directory.
For an overview of all tasks and weights in Retribution, run `dcs_liberation.exe dump-task-priorities` (from the command line). That will dump `Retribution/Debug/priorities.yaml` to your DCS Saved Games directory.
### DCS Liberation 6
@ -220,7 +220,7 @@ and the following line after the weapons definition class:
## Step 5: Factions
See [Custom Factions](Custom-Factions) and add the mods to the appropriate factions. If there are no appropriate factions, create a new one, but you don't need to worry about breaking existing factions by "requiring" the mod; Liberation will filter out mods that the player doesn't use.
See [Custom Factions](Custom-Factions) and add the mods to the appropriate factions. If there are no appropriate factions, create a new one, but you don't need to worry about breaking existing factions by "requiring" the mod; Retribution will filter out mods that the player doesn't use.
## Step 6: Resource files for aircraft

@ -1,4 +1,4 @@
This checklist describes the work needed to add support for a new aircraft module in Liberation. The same steps apply to both official modules and mods, though mods are often held to a lower standard.
This checklist describes the work needed to add support for a new aircraft module in Retribution. The same steps apply to both official modules and mods, though mods are often held to a lower standard.
The content below the line can be copied into the FR for tracking the work. Copy the source rather than the rendered view to preserve formatting in the bug. Mods should replace the first task (pydcs export) with the instructions in [[Modded aircraft support|Modded-Aircraft-Support]].
@ -8,14 +8,14 @@ The tasks below are rated P0-P2 to indicate their importance:
Priority | Description
--- | ---
P0 | Required. Module will not function in Liberation without completing these tasks. _Must_ be addressed before shipping in a release.
P0 | Required. Module will not function in Retribution without completing these tasks. _Must_ be addressed before shipping in a release.
P1 | Most modules complete these tasks. Commonly available features will not be available for the module if these tasks are skipped. Expect bug reports. Should be addressed before shipping in a release.
P2 | Many modules don't complete these tasks. Completing these tasks is required for complete functionality. Can be addressed in future releases.
- [ ] P0: pydcs export
1. Export latest DCS data by following the instructions at the top of [pydcs_export.lua](https://github.com/pydcs/dcs/blob/master/tools/pydcs_export.lua)
2. Send PR to pydcs
3. Update Liberation to the latest DCS
3. Update Retribution to the latest DCS
- [ ] P0: Add unit data to `resources/units/aircraft`. See [the F-16C data](https://github.com/dcs-retribution/dcs-retribution/blob/develop/resources/units/aircraft/F-16C_50.yaml) for a complete example.
- [ ] P0: Price. Compare to similar aircraft to determine what the price should be.
- [ ] P0: Variants. These are the names that will be used in the UI. At least one is required, but variants should be added for faction-specific types as necessary (e.g. a CF-18 variant for the Canadian F/A-18).

@ -1,4 +1,4 @@
To release a new version of DCS Liberation:
To release a new version of DCS Retribution:
1. Make sure the version number and changelog are up to date in the release branch. If the changelog needs to be updated, fix it in develop first and cherry-pick the updates to the release branch so they stay in sync.
2. Announce a preview build in #:loudspeaker:preview with the link to the GitHub Action for the specifc branch before creating the Release and wait some time. This allows to get some feedback on the build