3. Predefined Variants
Predefined variants are a list of variants that were made by the custom variants community. They are supposed to be easier to use than making your own custom variant using 5DFen. Unlike making your own custom variant, using predefined variants requires no editing of the code and can be used by people with the visual studio version as well as the precompiled version.
In every version of the Data Interface, you can find a folder called Resources containing a JsonVariants.json file, where the Resouces folder will be next to the DataInterfaceConsole.exe. For the precompiled versions this will be located directly in the zip you downloaded. For the visual studio version, this will be located in your build output directory.
The .json file is the same as the one you can find in the next section (Predefined Variants List). Modify this file locally, save it, and then select the Load Offline Variant option in the data interface console. The list of variants refreshes when you enter the Load Offline Variant menu. So you can load a variant, check it out in game, edit the .json file, save it, load the variant again and then observe the changes. Please test your variant(s) locally before suggesting them.
The list of predefined variants can be found here along with the authors of each variant as well as the 5DFen for each variant.
If at some point you want to suggest your own variant for the predefined variants list, you may go to the JSON file with all the other predefined variants (link is written above) and click edit.
Then you may edit the JSON and add your variant. Please keep in mind that you have to follow to correct syntax to add your variant. Once you are done editing the JSON file, you should write a commit message describing what you have changed.
Then, you can click on the Propose changes button and create a pull request.
Once the pull request is submitted several checks will be done automatically, to ensure that your changes meet certain requirements (e.g. Correct JSON syntax). Keep in mind that first-time contributors will need a maintainer to initiate the checks (so you may have to wait a while till the checks run).
If your change has failed any of the checks please review your changes and fix the errors. Once you successfully submit a pull request it will be reviewed by a maintainer.
If you pass the review your change will be added to the master branch of the data interface, and from that point on, the variant can be played by everyone.