Replies: 6 comments 4 replies
-
As an addition to this standardization I also suggest a new directory structure to make it easier for the standard user to locate loadout they want:
The README in the The README inside the |
Beta Was this translation helpful? Give feedback.
-
These rules can be enforced by creating contributor guidelines and amending the Pull Request template to enforce these rules. Additionally, a tool to verify filenames and directory structure could very easily be made that a contributor can run in vscode and that could also be run on new pull requests to verify them before merging |
Beta Was this translation helpful? Give feedback.
-
Added a branch where you can see an example of the changes I'm suggesting. filenames and structure has been fully completed. as for the READMEs only the path leading down to Norwegian loadouts have been completed. You can preview it here: standardizationExample branch |
Beta Was this translation helpful? Give feedback.
-
AmendmentAdding camouflage to the loadout file name as a mandatory parameter. Camouflageis a mandatory parameter that describes the most prevalent camouflage of the loadout. The standardized codes are:
Other camouflages are to be written in length (ie.: Flecktarn, Multicam). If the names are too long or have spaces in their name they are to be shortened to the most commonly used acronym for them (ie.: Desert Nigth Camouflage --> DNC). For the file structure, I had the idea of having packs for each unit containing the three files (loadout, logistics, garage) to be very quickly downloaded and thrown into a mission to avoid mixups and decrease the chance of someone putting in the wrong files. But I see an issue with edge cases where there is no garage and logistics file which would create an ugly file structure. |
Beta Was this translation helpful? Give feedback.
-
I have added slightly changed versions of the following categories, copied from your messages above @Tapawingo to the wiki of this repository. They are now set standards. |
Beta Was this translation helpful? Give feedback.
-
I just noticed that the version number for the Cluster Community Modpack is not in the standardized naming format. |
Beta Was this translation helpful? Give feedback.
-
Description of Standardization
I think a standardization of filenames would be a good idea to make it more clear. It will also make developing tools for searching and indexing loadouts easier. I suggest the following format:
[countrycode]_[era]_[unit]_[additionalInfo].sqf
The entire name should be in lower case for case sensitive searches. This is especially important for Arma instances running on linux as the search is case sensitive.
whitespaces should not be used for the same reason as above.
keywords should be delimited by an underscore
_
.Format and Syntax Description
countrycode
Country code
should use the ISO 3166 Alpha 3 country codes to denote the loadout's country. If a country isn't listed in the ISO 3166 standard or if the loadout isn't linked to a particular country other short-format codes should be used. It is important however that these short-format codes do not match any existing country codes from ISO 3166 and thus when one is made it is important that the newly created code is checked against the ISO 3166 list.To create some early standardizations for missing codes I suggest the following to be standardized:
era
The
era
would denote a time period for the loadout. It should be one of the following formats (where Y is year):YYYY
,YYYY-YYYY
,YYs
,YYs-YYs
,timeperiod
(e.g. coldwar) orna
(for Not Applicable)unit
Unit
is an optional parameter, the only requirements are that it is in lowercase. This keyword can be omitted if deemed unnecessary for describing the loadout or if it's not applicable.additionalinfo
Additional Info
is an optional parameter, the only requirements are that it is in lowercase. This keyword can be omitted if deemed unnecessary for describing the loadout or if it's not applicable.Beta Was this translation helpful? Give feedback.
All reactions