Github - Imperia-Development-Victoria-3/Victoria-3-dev-utilities GitHub Wiki

1. Download and install GitHub Desktop.

2. Sign in to GitHub Desktop with your GitHub account.

3. Click on File > Clone Repository from the menu bar.

4. Under the URL tab, input the URL of the repository you want to clone (this should be either the Victoria-3-Dev or Victoria-External repository, as appropriate).

5. For the local path, navigate to your mod folder for Victoria 3. This will typically be in the Documents/Paradox interactive/Victoria 3/mod/ directory. If this directory doesn't exist, create one.

6. Click on Clone.

Remember, you will be working with the cloned repository located in your Victoria 3 mod folder.

• Branching: This is the practice of creating a new 'branch' in your repository to isolate your work. Our repository uses specific naming conventions for branches, detailed later in this guide.

• Pull Requests (PRs): After making changes in your branch, you request to merge them into another branch (usually the Imperia-Core branch) through a pull request. PRs undergo review before getting merged.

• Commits: These are individual changes you make to the files in your branch. Each commit should be a logical unit of work, and the commit message should clearly describe what the change does.

We have two main repositories:

1. Victoria-3-Dev: We use this repository to develop our own changes to the game.

   • Imperia-Core, all our custom features implemented. No External mods.
   • <Weekday>, a branch for a specific session on a specific weekday.
   • Imperia-<feature>, a branch for (internal) individual features which are not ready yet. This is your main workzone.

2. Victoria-External: We use this repository to gather external mods and make them compatible.

   • External-<mod>, a separate branch for external mods we (want to) integrate.
   • Mod-main, a working version which we actually work on to solve mod contradictions.
   • Vanilla, a branch which tracks vanilla changes. All except graphics objects and soundfiles. Requires special handling.*
   • Main, a working version of our mod which combines all the external mods and our own features. No actual work should be done here.

If you want to contribute, follow these steps:

1. Make your own branch following the naming conventions mentioned above.

2. Develop your changes on this new branch.

3. Create a pull request to propose your changes to be merged into the main branch.

4. Have someone review your pull request.

5. Make corrections based on the review feedback.

6. Repeat steps 4 and 5 until your pull request is approved.

7. Use 'Squash and Merge' to merge your pull request.

8. Delete the branch after merging to keep the repository clean.