Difference between revisions of "Using Git for Modding"
SteadyEddie (talk | contribs) (→Offline use) |
|||
| Line 7: | Line 7: | ||
==Using Git== | ==Using Git== | ||
===Offline use=== | ===Offline use=== | ||
| + | [[File:ExampleCommit.png|640px|thumb|An example commit on GitHub]] | ||
# Install Git ([https://git-scm.com/download/win official download for windows]) | # Install Git ([https://git-scm.com/download/win official download for windows]) | ||
# Open a terminal and navigate to your mod folder (e.g: <code>cd C:\Users\eddie\games\medieval II total war\mods\my_important_mod</code>) | # Open a terminal and navigate to your mod folder (e.g: <code>cd C:\Users\eddie\games\medieval II total war\mods\my_important_mod</code>) | ||
| Line 14: | Line 15: | ||
# Run <code>git commit -m "Adding working files"</code> | # Run <code>git commit -m "Adding working files"</code> | ||
# Repeat the <code>git add .</code>and <code>git commit -m "Some appropriate message detailing what changes you made"</code> steps as you make changes or discard them if you don't want them | # Repeat the <code>git add .</code>and <code>git commit -m "Some appropriate message detailing what changes you made"</code> steps as you make changes or discard them if you don't want them | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
You should now have a working local git repository! Consult one of the following guides for instructions how to make the most of git from the command line: | You should now have a working local git repository! Consult one of the following guides for instructions how to make the most of git from the command line: | ||
| Line 30: | Line 25: | ||
===Free Git Hosting Services=== | ===Free Git Hosting Services=== | ||
| − | * [ | + | * [https://github.com Github] |
| − | * [ | + | * [https://about.gitlab.com/ GitLab] |
| − | * [ | + | * [https://sourceforge.net/ SourceForge] |
==Additional considerations== | ==Additional considerations== | ||
There should not be issues with publishing (for example) a Medieval 2 mod folder to GitHub, but attribution/permission from original creators should be observed if this is being done with existing projects. Obviously, publishing copyrighted works and core game files should not be done. | There should not be issues with publishing (for example) a Medieval 2 mod folder to GitHub, but attribution/permission from original creators should be observed if this is being done with existing projects. Obviously, publishing copyrighted works and core game files should not be done. | ||
Revision as of 13:03, 12 October 2023
Instructions originally written by Medik on Discord, who deserves full credit for inspiring this page.
Git is a version control tool used in both professional and hobby environments. It tracks changes made, has powerful version comparison and control, and offers an industry-relevant, professional way to create mods for a fairly low learning investment.
If combined with a site such as Github, this process can allow teams to collaborate without stepping on each other's toes, to more clearly observe what is happening and who does what, and even allow unrelated people to offer suggestions and report bugs in the same interface.
Using Git
Offline use
- Install Git (official download for windows)
- Open a terminal and navigate to your mod folder (e.g:
cd C:\Users\eddie\games\medieval II total war\mods\my_important_mod) - Create a new .gitignore file (example: DAC gitignore on github) to tell Git to ignore certain files (such as images, models and textures as desired)
- Run
git initto tell Git to watch the directory - Run
git add .to add all your existing files that work - Run
git commit -m "Adding working files" - Repeat the
git add .andgit commit -m "Some appropriate message detailing what changes you made"steps as you make changes or discard them if you don't want them
You should now have a working local git repository! Consult one of the following guides for instructions how to make the most of git from the command line:
You can also manage Git graphically if you prefer.
Free Git Hosting Services
Additional considerations
There should not be issues with publishing (for example) a Medieval 2 mod folder to GitHub, but attribution/permission from original creators should be observed if this is being done with existing projects. Obviously, publishing copyrighted works and core game files should not be done.
