Setting up an Online Repository - Revision history

Darkfire: /* HPL Engine Specifics */ update formatting and info

2024-03-24T11:30:48Z

HPL Engine Specifics: update formatting and info

Darkfire: Add new content, make a few things more understandable

2024-03-23T17:38:31Z

Add new content, make a few things more understandable

Show changes

Darkfire: Rewrite

2021-04-11T12:56:06Z

Rewrite

TiMan: oops

2020-11-04T11:00:19Z

oops

TiMan: /* HPL Engine-Specifics */

2020-09-09T06:37:46Z

HPL Engine-Specifics

TiMan: /* HPL Engine-Specifics */

2020-09-09T06:37:24Z

HPL Engine-Specifics

TiMan: /* Cloning the Project using GitKraken */

2020-08-27T09:43:36Z

Cloning the Project using GitKraken

TiMan: /* Terminology */

2020-07-31T19:35:03Z

Terminology

TiMan: /* Terminology */

2020-07-31T19:34:12Z

Terminology

TiMan: /* Terminology */

2020-07-31T19:33:57Z

Terminology

@@ Line 154: / Line 154: @@
 ==HPL Engine Specifics==
-When it comes to modding with the HPL engine, the following files should be added to the [https://git-scm.com/docs/gitignore .gitignore] list:
+When it comes to modding on the HPL engine, the following files should be added to the [https://git-scm.com/docs/gitignore .gitignore file]:
-*<code>*.map_cache</code>
+<pre>
-*<code>*.preload_cache</code>
+*.map_cache
 The files on the gitignore list won't show up in your changes list between commits, making it much less cluttered.
-Another thing to note is that HPL2's map format is not designed with version control in mind.
+Another thing to note is that unlike HPL3, HPL2's map format is not designed with version control in mind.
-This means that if you and your teammate change the same map, the changes might be impossible to merge in reasonable time.
+This means that if you and your teammate both change the same map, the changes might be impossible to merge.
 As such, you should avoid working on the same maps at the same time.
 ==See Also==

@@ Line 1: / Line 1: @@
-This article describes the process of setting up an online Git repository, and discusses the workflow.
+This article is about '''version control'''. It describes the process of setting up an online Git repository, and discusses the workflow.
 {{Note|The sole purpose of the article is to explain how to set a repository up and running. '''Check "See Also" in order to learn how to actually operate and maintain the repository.'''}}<br>
-==Why do I Need a Repository?==
+==Introduction==
-The biggest benefit is to combine changes made by all members of the mod team into a single "current" copy. If you're working on a mod by yourself, you probably don't need an online repository. However, an offline one will still give you many other benefits, which online repositories also provide. If you break something, you can easily compare to the previous version (or rollback to it), and easily keep track of exactly what things you've changed since the previous version.
+===Version control===
 ==Terminology==
@@ Line 10: / Line 22: @@
 {| class="wikitable"
 |Commit
-|A snapshot of the project. Its purpose is to allow to revert unwanted changes and any accidents (such as deleting something). On the graph below, individual dots are commits.
+|A snapshot of project changes. Its purpose is to allow to revert unwanted changes and any accidents. On the graph below, individual dots are commits.
 |-
 |Pull
 |"Download" commits from the branch in the repository. You pull in order to update the project on your end.
 |-
 |Push
-|"Upload" your local commits to the repository. You push in order to update the project on the repository.
+|"Upload" your local commits to the online repository. You push in order to update the project on the repository.
 |-
 |Repository
-|The service that stores each commit; it is often used as a substitute for the folder which holds the project.
+|The data structure that stores each commit; it is often used as a substitute for the folder which holds the project.
 |-
 |Branch
-|A separate chain of commits; think of it as making your own version of the project, while others make their own ones.
+|A separate chain of commits; think of it as making your own version of the project, while others make their own ones. You can also have multiple branches made for different purposes. For example, it is advised to create a new branch when you want to test something that might break the project but can't be done in a single commit.
 |-
 |Master Branch
-|The mutual version of the project; every now and then you (or the project manager) will need to merge your version with the "official" (master) one. This will create a new commit. However, before branches can be merged, you will need to push your changes to the online repository. You should also make it a habit to pull from the master branch before starting any work.
+|The main version of the project. It is customary to only put stable versions of the project in the master branch. A good practice is to create separate branches for work-in-progress commits and merge them into the master branch when the feature in question is finished.
 |-
-|Tip
+|Pull/Merge request
-|The latest commit in a branch.
+|If you're not an admin on the repo, you won't have the permission to push to the master branch. To have your work merged into the master, you will need to push your branch to the online repo, and then request the merge. This is called a Merge Request on Gitlab and (a bit confusingly) Pull Request on Github.
 |}
@@ Line 36: / Line 58: @@
 One of the easiest ways to setup an online repository is to use the following services:
-*GitLab
+*GitLab (online repo storage)
-*GitKraken
+*GitKraken (a GUI for Git)
 It is necessary to install GitKraken on our local machine and later set up the local and online repository.
@@ Line 43: / Line 65: @@
 #[https://gitlab.com/ Register a free account at GitLab]
 #[https://www.gitkraken.com/ Download and install GitKraken Git GUI]
 ==Creating the Project on GitLab==
@@ Line 69: / Line 93: @@
 #Select the '''Repository to clone''' and click on '''Clone the repo!'''
 #Wait until the files are copied. When it's done, a prompt will show up to open the repo in the app - click on it to open the repository window.
-#You can now create branches, commit, pull and push your changes via GItKraken!
+#You can now create branches, commit, pull and push your changes via GitKraken!
 ==HPL Engine-Specifics==
@@ Line 77: / Line 101: @@
 *<code>*.preload_cache</code>
 ==See Also==
 [https://www.youtube.com/watch?v=HVsySz-h9r4 Git Tutorial: Command-line Fundamentals]

@@ Line 4: / Line 4: @@
 ==Why do I Need a Repository?==
-The biggest benefit is to combine changes made by all members of the mod team into a single "current" copy. If you're working on a mod by yourself, you probably don't need an online repository. However, an offline one will still give you many other benefits, which online repositories also provide. If you break something, you can easily compare to the previous version (or rollback to it), and easily keep track of exactly what things you've changed since the previous version. Also, if valve update the source code, a repository can make the task of merging the two versions of the code considerably easier.
+The biggest benefit is to combine changes made by all members of the mod team into a single "current" copy. If you're working on a mod by yourself, you probably don't need an online repository. However, an offline one will still give you many other benefits, which online repositories also provide. If you break something, you can easily compare to the previous version (or rollback to it), and easily keep track of exactly what things you've changed since the previous version.
 ==Terminology==
@@ Line 71: / Line 71: @@
 #You can now create branches, commit, pull and push your changes via GItKraken!
-== HPL Engine-Specifics ==
+==HPL Engine-Specifics==
 When it comes to modding with the HPL engine, the following files should be added to the [https://git-scm.com/docs/gitignore .gitignore] list:
-* <code>*.map_cache</code>
+*<code>*.map_cache</code>
-* <code>*.preload_cache</code>
+*<code>*.preload_cache</code>
 ==See Also==

@@ Line 74: / Line 74: @@
 When it comes to modding with the HPL engine, the following files should be added to the [https://git-scm.com/docs/gitignore .gitignore] list:
 * <code>*.map_cache</code>
 * <code>*.preload_cache</code>

@@ Line 74: / Line 74: @@
 When it comes to modding with the HPL engine, the following files should be added to the [https://git-scm.com/docs/gitignore .gitignore] list:
-* <code>.map_cache.hpm</code>
+* <code>*.map_cache</code>
-* <code>.preload_cache.hpm</code>
+* <code>*.map_cache</code>
 ==See Also==

@@ Line 7: / Line 7: @@
 ==Terminology==
-[[File:Git-branch-demonstration.png|alt=|thumb|Git branches are useful to separate your version from the main project version, and later be merged when your work is done.The master branch is blue, and the side branch is green.]]
+[[File:Git-branch-demonstration.png|alt=|thumb|Git branches are useful to separate your version from the main project version, and later be merged when your work is done. The master branch is blue, and the side branch is green.]]
 {| class="wikitable"
 |Commit

@@ Line 32: / Line 32: @@
 |The latest commit in a branch.
 |}
 ==Getting Started==