weyne/dcs-retribution
1
0
Fork 0
mirror of https://github.com/dcs-retribution/dcs-retribution.git synced 2025-11-10 15:41:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Custom Factions (markdown)

Dan Albert 2023-04-17 23:42:11 -07:00
parent 239207896d
commit 065c20ec20
1 changed files with 9 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Custom-Factions.md

@ -3,25 +3,22 @@
Frustrated that your home country is not a possible choice in DCS Liberation, or annoyed that an aircraft is missing in your favorite faction?
Good news, you can now mod factions in liberation!
And these custom factions can be created easily with a text editor as a json file.
And these custom factions can be created easily with a text editor as a yaml or json file (prefer yaml for new factions).
You can find the default factions included in Liberation in the **\resources\factions\\** folder within the Liberation install directory. If you have created your own custom faction files and wish to place them in a more permanent location, you have the option of placing them instead in the DCS folder itself, by creating a folder call "Factions" (Liberation will read faction files from either location). This would be the same location that is listed as your "DCS Saved Game Directory" under File > Preferences in Liberation. As an example, if you are running Openbeta, it would likely be **C:\users\\\<your username\>\\Saved Games\DCS.openbeta\Liberation\Factions\\**.
![](https://imgur.com/hiqrYEh.png)
Then restart DCS Liberation to have the faction loaded.
Note that until DCS Liberation 7, you will need to restart Liberation for new or updated factions to be detected.
If there is no error, your custom faction will appear in the New Game Wizard. Please note that factions saved in your DCS saved games folder will appear at the bottom of the list and not in alphabetical order.
If there is an error with the file it will not appear, please check the content of the console output, it might contain hints about the error. First, please verify the json syntax is valid.
If there is an error with the file it will not appear, please check the content of the console output, it might contain hints about the error. First, please verify the yanl/json syntax is valid.
# File format
**The file format changed with DCS Liberation 6.0**\
For Version 5.1.X you can find the documentation here [Custom Factions](https://github.com/dcs-liberation/dcs_liberation/wiki/Custom-Factions/591260356de497450fce073bb5baf20c035a768e)
This json file should contain a json object, with the following parameters :
This yaml or json file should contain the following fields:
* **country** : The country to be used in DCS. Careful, if it is not a valid country name in DCS, the mission generation will not work.
* **name** : Name of the faction in DCS Liberation UI
@ -46,7 +43,7 @@ This json file should contain a json object, with the following parameters :
* **liveries_overrides** : List of aircraft and liveries to set. It is possible to have multiple liveries for aircraft, and Liberation will pick one out of the list randomly. The livery must be available to the country set in order to appear. If the livery doesn't show up in Mission Editor for that country, it won't show up in your Liberation mission either. The name of the livery can be found in its description.lua (if it's not there, then use the exact name of the livery's folder).
* **unrestricted_satnav** : Enable this option to allow unrestricted SATNAV in the mission. This will allow the use of GPS by non-US countries, e.g. non-US F/A-18s will be able to use GPS for alignment. This value is optional and may be either `true` or `false`. If not set this defaults to `false`.
**Note :**
**Note:**
*I highly recommend you look at the default files provided in DCS Liberation for examples.*
All parameters have default values, so you do not have to set them all up necessarily.
@ -57,11 +54,7 @@ It is recommended, that your faction has access to all unit types, e.g. at least
## Aircraft, ground unit und naval names
**New in DCS Liberation 4.0**
_Since DCS Liberation 6.0 this also includes naval units_
Ground, naval and air units are now named by the name of the unit in Liberation rather than the name in DCS. This was done so DCS updates no longer break custom factions. Previously, if ED improved the name of a unit in DCS it would require an update to custom factions. Instead the faction files now use the Liberation names so we can prevent breakages from occurring.
Ground, naval, and air units in the faction file use the name of the unit in Liberation rather than the name in DCS.
The names used are taken from the `variants` section of the unit info files in the `resources/units` directory. For example, `units/aircraft/FA-18C_hornet.yaml` contains the following:
@ -78,9 +71,7 @@ Ground units use the same format, but are located in `resources/units/ground_uni
## Preset Groups
**New in DCS Liberation 6.0**
With Liberation 6.0 the ground objects were reworked and the generators were migrated to a layout system. Therefore it is not necassary to define generators in the faction file. Instead you can now define so called Preset Groups in the Faction file. All available preset groups are located in `resources/groups`. They can be added to the faction by adding the name from the preset group in the list `preset_groups`. All units from the preset group will then be available to the faction. A more detailed description of the preset groups and the new layout system can be found in the corresponding wiki page.
Ground and naval objectives (as opposed to front-line units) are defined using preset groups.. All available preset groups are located in `resources/groups`. They can be added to the faction by adding the name from the preset group in the list `preset_groups`. All units from the preset group will then be available to the faction. A more detailed description of the preset groups and the new layout system can be found in the corresponding wiki page.
```yaml
name: Patriot # This name will be placed in the faction json
@ -202,6 +193,8 @@ Below is an example of a factions file :
## Annex - Possible Aircraft
Warning: this list is probably incomplete and wrong. It is not kept up to date when Liberation changes. If you want the truth you have to look at the YAML files shipped with the version of Liberation you're using.
* *A-4E Skyhawk*
* *A-10A Thunderbolt II*
* *A-10C Thunderbolt II (Suite 7)*