Development:Working With Git - Revision history

Move page script: Move page script moved page Dev:Working With Git to Development:Working With Git: Rename Dev: to Development: so the miraheze import works

2024-03-27T03:56:50Z

Move page script moved page Dev:Working With Git to Development:Working With Git: Rename Dev: to Development: so the miraheze import works

← Older revision	Revision as of 03:56, 27 March 2024
(No difference)

Jesusalva: Text replacement - "git://" to "https://"

2022-06-13T01:06:57Z

Text replacement - "git://" to "https://"

← Older revision		Revision as of 01:06, 13 June 2022
Line 36:		Line 36:
	If you are using Linux, open a terminal window.		If you are using Linux, open a terminal window.
	*Navigate to the folder where you want to create your clone.		*Navigate to the folder where you want to create your clone.
	*Now issue the command to have Git create a copy: '''''git clone --recursive ~~git~~://git.themanaworld.org/evolved/serverdata.git serverdata'''''		*Now issue the command to have Git create a copy: '''''git clone --recursive https://git.themanaworld.org/evolved/serverdata.git serverdata'''''
	**The ''--recursive'' command tells Git to copy all of the data from the included submodules (client-data and music). If you don't plan on working with these, it can be omitted.		**The ''--recursive'' command tells Git to copy all of the data from the included submodules (client-data and music). If you don't plan on working with these, it can be omitted.
	** Currently, only TMWA has these as submodules, so it can also be omitted.		** Currently, only TMWA has these as submodules, so it can also be omitted.
	**The ''serverdata'' at the end of the command is the name of the folder you want the data in. In the example, ''git clone --recursive ~~git~~://git.themanaworld.org/evolved/serverdata.git serverdata'' will create a new folder called serverdata and put the files inside that folder. You can use any folder name that makes sense to you.		**The ''serverdata'' at the end of the command is the name of the folder you want the data in. In the example, ''git clone --recursive https://git.themanaworld.org/evolved/serverdata.git serverdata'' will create a new folder called serverdata and put the files inside that folder. You can use any folder name that makes sense to you.

	Note that copying the data may take some time.		Note that copying the data may take some time.

Jesusalva: Text replacement - "git@gitlab.com:" to "https://git.themanaworld.org/"

2022-06-13T01:06:00Z

Text replacement - "git@gitlab.com:" to "https://git.themanaworld.org/"

← Older revision		Revision as of 01:06, 13 June 2022
Line 21:		Line 21:
	To create a fork, login to your GitLab account and go to the [https://git.themanaworld.org/evolved/serverdata/ TMW Repository].		To create a fork, login to your GitLab account and go to the [https://git.themanaworld.org/evolved/serverdata/ TMW Repository].
	*You will see a button on the page that says Fork. Click it.		*You will see a button on the page that says Fork. Click it.
	*You should now see a page that has some details and history for the fork you just created. At the top will be a series of buttons including one that says SSH. Clicking the SSH button will create a link for you to copy which will be needed in the next step. It will look like ''git~~@gitlab~~.~~com:~~yournamehere/serverdata.git''. Copy that link or keep the page open; we'll need it later.		*You should now see a page that has some details and history for the fork you just created. At the top will be a series of buttons including one that says SSH. Clicking the SSH button will create a link for you to copy which will be needed in the next step. It will look like ''https://git.themanaworld.org/yournamehere/serverdata.git''. Copy that link or keep the page open; we'll need it later.

	If you will be working with client-data or music, you will need to create separate forks for those repositories as well.		If you will be working with client-data or music, you will need to create separate forks for those repositories as well.
Line 49:		Line 49:
	When a repo (short for repository) is cloned, it has a default remote called ''origin'' that points to the repo it was cloned from. To allow you to make changes on your personal fork, you need to add another remote which we will name ''fork''.		When a repo (short for repository) is cloned, it has a default remote called ''origin'' that points to the repo it was cloned from. To allow you to make changes on your personal fork, you need to add another remote which we will name ''fork''.
	*Change to the directory you created when you cloned your repo: '''''cd serverdata'''''		*Change to the directory you created when you cloned your repo: '''''cd serverdata'''''
	*Using the link we found at the end of the Creating a Fork section, issue the command '''''git remote add fork git~~@gitlab~~.~~com:~~yournamehere/serverdata.git'''''		*Using the link we found at the end of the Creating a Fork section, issue the command '''''git remote add fork https://git.themanaworld.org/yournamehere/serverdata.git'''''

	We'll also need to add remote pointers and select the correct branch for the submodules, if you cloned them. This currently only applies to tmwa servers.		We'll also need to add remote pointers and select the correct branch for the submodules, if you cloned them. This currently only applies to tmwa servers.
	*'''''cd client-data'''''		*'''''cd client-data'''''
	*'''''git remote add client-data git~~@gitlab~~.~~com:~~yournamehere/clientdata.git'''''		*'''''git remote add client-data https://git.themanaworld.org/yournamehere/clientdata.git'''''
	*'''''git checkout master'''''		*'''''git checkout master'''''
	*'''''cd music'''''		*'''''cd music'''''
	*'''''git remote add music git~~@gitlab~~.~~com:~~yournamehere/tmw-music.git'''''		*'''''git remote add music https://git.themanaworld.org/yournamehere/tmw-music.git'''''
	*'''''git checkout master'''''		*'''''git checkout master'''''

Jesusalva: Text replacement - "gitlab.com/themanaworld/evolved" to "git.themanaworld.org/evolved"

2022-06-13T01:02:56Z

Text replacement - "gitlab.com/themanaworld/evolved" to "git.themanaworld.org/evolved"

Jesusalva: Github -> Gitlab

2022-01-23T19:21:27Z

Github -> Gitlab

← Older revision		Revision as of 19:21, 23 January 2022
Line 1:		Line 1:
	Git is a distributed revision control and source code management system.		Git is a distributed revision control and source code management system.

	[https://github.com/ GitHub] ~~is a~~ web-based hosting service for projects that use the Git revision control system.		[https://github.com/ GitHub] and [https://gitlab.com/ GitLab] are web-based hosting service for projects that use the Git revision control system.

	Together, these two tools allow developers working on The Mana World to easily collaborate and merge changes into the game.		Together, these two tools allow developers working on The Mana World to easily collaborate and merge changes into the game.
Line 17:		Line 17:

	=== Creating a Fork ===		=== Creating a Fork ===
	Once you have installed Git, your first task should be to create a personal copy (also known as a fork) of the server data on your ~~GitHub~~ account. This will allow you to make changes and save them to a place where the content leaders can retrieve copies to include in the main server. It's also easier to work with.		Once you have installed Git, your first task should be to create a personal copy (also known as a fork) of the server data on your GitLab account. This will allow you to make changes and save them to a place where the content leaders can retrieve copies to include in the main server. It's also easier to work with.

	To create a fork, login to your ~~GitHub~~ account and go to the [https://~~github~~.com/themanaworld/~~tmwa-server-data~~/ TMW Repository].		To create a fork, login to your GitLab account and go to the [https://gitlab.com/themanaworld/evolved/serverdata/ TMW Repository].
	*You will see a button on the page that says Fork. Click it.		*You will see a button on the page that says Fork. Click it.
	*You should now see a page that has some details and history for the fork you just created. At the top will be a series of buttons including one that says SSH. Clicking the SSH button will create a link for you to copy which will be needed in the next step. It will look like ''git@~~github~~.com:yournamehere/~~tmwa-server-data~~.git''. Copy that link or keep the page open; we'll need it later.		*You should now see a page that has some details and history for the fork you just created. At the top will be a series of buttons including one that says SSH. Clicking the SSH button will create a link for you to copy which will be needed in the next step. It will look like ''git@gitlab.com:yournamehere/serverdata.git''. Copy that link or keep the page open; we'll need it later.

	If you will be working with client-data or music, you will need to create separate forks for those repositories as well.		If you will be working with client-data or music, you will need to create separate forks for those repositories as well.
	*[https://~~github~~.com/themanaworld/~~tmwa-client-data~~/ client-data]		*[https://gitlab.com/themanaworld/evolved/clientdata/ client-data]
	*[https://~~github~~.com/themanaworld/tmw-music/ music]		*[https://gitlab.com/themanaworld/tmw-music/ music]

			Keep in mind you'll need more tools to run a localhost, see appropriate pages regarding that.

	=== Creating a Clone ===		=== Creating a Clone ===
Line 34:		Line 36:
	If you are using Linux, open a terminal window.		If you are using Linux, open a terminal window.
	*Navigate to the folder where you want to create your clone.		*Navigate to the folder where you want to create your clone.
	*Now issue the command to have Git create a copy: '''''git clone --recursive git://~~github~~.com/themanaworld/~~tmwa-server-data~~.git ~~TMW~~'''''		*Now issue the command to have Git create a copy: '''''git clone --recursive git://gitlab.com/themanaworld/evolved/serverdata.git serverdata'''''
	**The ''--recursive'' command tells Git to copy all of the data from the included submodules (client-data and music). If you don't plan on working with these, it can be omitted.		**The ''--recursive'' command tells Git to copy all of the data from the included submodules (client-data and music). If you don't plan on working with these, it can be omitted.
	**The ''~~TMW~~'' at the end of the command is the name of the folder you want the data in. In the example, ''git clone --recursive git://~~github~~.com/themanaworld/~~tmwa-server-data~~.git ~~TMW~~'' will create a new folder called ~~TMW~~ and put the files inside that folder. You can use any folder name that makes sense to you.		** Currently, only TMWA has these as submodules, so it can also be omitted.
			**The ''serverdata'' at the end of the command is the name of the folder you want the data in. In the example, ''git clone --recursive git://gitlab.com/themanaworld/evolved/serverdata.git serverdata'' will create a new folder called serverdata and put the files inside that folder. You can use any folder name that makes sense to you.

	Note that copying the data may take some time.		Note that copying the data may take some time.
Line 45:		Line 48:

	When a repo (short for repository) is cloned, it has a default remote called ''origin'' that points to the repo it was cloned from. To allow you to make changes on your personal fork, you need to add another remote which we will name ''fork''.		When a repo (short for repository) is cloned, it has a default remote called ''origin'' that points to the repo it was cloned from. To allow you to make changes on your personal fork, you need to add another remote which we will name ''fork''.
	*Change to the directory you created when you cloned your repo: '''''cd ~~TMW~~'''''		*Change to the directory you created when you cloned your repo: '''''cd serverdata'''''
	*Using the link we found at the end of the Creating a Fork section, issue the command '''''git remote add fork git@~~github~~.com:yournamehere/~~tmwa-server-data~~.git'''''		*Using the link we found at the end of the Creating a Fork section, issue the command '''''git remote add fork git@gitlab.com:yournamehere/serverdata.git'''''

	We'll also need to add remote pointers and select the correct branch for the submodules, if you cloned them.		We'll also need to add remote pointers and select the correct branch for the submodules, if you cloned them. This currently only applies to tmwa servers.
	*'''''cd client-data'''''		*'''''cd client-data'''''
	*'''''git remote add client-data git@~~github~~.com:yournamehere/~~tmwa-client-data~~.git'''''		*'''''git remote add client-data git@gitlab.com:yournamehere/clientdata.git'''''
	*'''''git checkout master'''''		*'''''git checkout master'''''
	*'''''cd music'''''		*'''''cd music'''''
	*'''''git remote add music git@~~github~~.com:yournamehere/tmw-music.git'''''		*'''''git remote add music git@gitlab.com:yournamehere/tmw-music.git'''''
	*'''''git checkout master'''''		*'''''git checkout master'''''

	Git includes the ability to work with ''branches'', or multiple versions of files. This can provide a way to work on separate projects without having to create a new clone for each one. We won't be going too deeply into this option, but the option is there once you are more comfortable. By default, you will be working on the ''master'' branch. The command above, ''git checkout master'', tells the submodule which branch you want to use.		Git includes the ability to work with ''branches'', or multiple versions of files. This can provide a way to work on separate projects without having to create a new clone for each one. We won't be going too deeply into this option, but the option is there once you are more comfortable. By default, you will be working on the ''master'' branch. The command above, ''git checkout master'', tells the submodule which branch you want to use.

	At this point you now have a personal fork, a local clone, and remote pointers for your fork. You're ready to start making changes! You are free to use whatever tools work for you to make your changes, but please ensure that the final results are in harmony with The Mana World's formatting guidelines. [[TmwAthena Scripting Standards]]		At this point you now have a personal fork, a local clone, and remote pointers for your fork. You're ready to start making changes! You are free to use whatever tools work for you to make your changes, but please ensure that the final results are in harmony with The Mana World's formatting guidelines. There's [[TmwAthena Scripting Standards]] and Evol2 Scripting Standards (the later based on Linux Kernel Convention).

	== Day-to-day Use ==		== Day-to-day Use ==
Line 74:		Line 77:
	=== Making Commits ===		=== Making Commits ===

	After making changes to any of the source files (maps, graphics, scripts) you will want to save those changes so other developers can see and review them. You need to commit those changes to Git. When committing files to Git, you will need to have a terminal or Git Bash open in the directory containing the changes. For example, if you are changing music files, you will need to be in the ''TMW/~~client-data~~/music'' folder.		After making changes to any of the source files (maps, graphics, scripts) you will want to save those changes so other developers can see and review them. You need to commit those changes to Git. When committing files to Git, you will need to have a terminal or Git Bash open in the directory containing the changes. For example, if you are changing music files, you will need to be in the ''TMW/clientdata/music'' folder.

	Your first step toward making a commit is to verify that Git recognizes there have been changes.		Your first step toward making a commit is to verify that Git recognizes there have been changes.

Jaxad0127: Jaxad0127 moved page Working With Git to Dev:Working With Git

2013-06-07T14:11:16Z

Jaxad0127 moved page Working With Git to Dev:Working With Git

← Older revision	Revision as of 14:11, 7 June 2013
(No difference)

Kandiman at 21:25, 9 June 2012

2012-06-09T21:25:22Z

← Older revision		Revision as of 21:25, 9 June 2012
Line 58:		Line 58:
	Git includes the ability to work with ''branches'', or multiple versions of files. This can provide a way to work on separate projects without having to create a new clone for each one. We won't be going too deeply into this option, but the option is there once you are more comfortable. By default, you will be working on the ''master'' branch. The command above, ''git checkout master'', tells the submodule which branch you want to use.		Git includes the ability to work with ''branches'', or multiple versions of files. This can provide a way to work on separate projects without having to create a new clone for each one. We won't be going too deeply into this option, but the option is there once you are more comfortable. By default, you will be working on the ''master'' branch. The command above, ''git checkout master'', tells the submodule which branch you want to use.

	At this point you now have a personal fork, a local clone, and remote pointers for your fork. You're ready to start making changes! You are free to use whatever tools work for you to make your changes, but please ensure that the final results are in harmony with The Mana World's formatting guidelines. ~~(Link needed)~~		At this point you now have a personal fork, a local clone, and remote pointers for your fork. You're ready to start making changes! You are free to use whatever tools work for you to make your changes, but please ensure that the final results are in harmony with The Mana World's formatting guidelines. [[TmwAthena Scripting Standards]]

	== Day-to-day Use ==		== Day-to-day Use ==

Kandiman at 19:48, 9 June 2012

2012-06-09T19:48:00Z

← Older revision		Revision as of 19:48, 9 June 2012
Line 48:		Line 48:
	*Using the link we found at the end of the Creating a Fork section, issue the command '''''git remote add fork git@github.com:yournamehere/tmwa-server-data.git'''''		*Using the link we found at the end of the Creating a Fork section, issue the command '''''git remote add fork git@github.com:yournamehere/tmwa-server-data.git'''''

	We'll also need to add remote pointers for the submodules, if you cloned them.		We'll also need to add remote pointers and select the correct branch for the submodules, if you cloned them.
	*'''''cd client-data'''''		*'''''cd client-data'''''
	*'''''git remote add client-data git@github.com:yournamehere/tmwa-client-data.git'''''		*'''''git remote add client-data git@github.com:yournamehere/tmwa-client-data.git'''''
			*'''''git checkout master'''''
	*'''''cd music'''''		*'''''cd music'''''
	*'''''git remote add music git@github.com:yournamehere/tmw-music.git'''''		*'''''git remote add music git@github.com:yournamehere/tmw-music.git'''''
			*'''''git checkout master'''''

			Git includes the ability to work with ''branches'', or multiple versions of files. This can provide a way to work on separate projects without having to create a new clone for each one. We won't be going too deeply into this option, but the option is there once you are more comfortable. By default, you will be working on the ''master'' branch. The command above, ''git checkout master'', tells the submodule which branch you want to use.
	Git includes the ability to work with ''branches'', or multiple versions of files. This can provide a way to work on separate projects without having to create a new clone for each one. We won't be going too deeply into this option, but the option is there once you are more comfortable. By default, you will be working on the ''master'' branch.

	At this point you now have a personal fork, a local clone, and remote pointers for your fork. You're ready to start making changes! You are free to use whatever tools work for you to make your changes, but please ensure that the final results are in harmony with The Mana World's formatting guidelines. (Link needed)		At this point you now have a personal fork, a local clone, and remote pointers for your fork. You're ready to start making changes! You are free to use whatever tools work for you to make your changes, but please ensure that the final results are in harmony with The Mana World's formatting guidelines. (Link needed)
Line 88:		Line 89:
	Once you have committed your changes to your local clone, you now have to put them where they can be seen: your fork. To ensure that your fork will match what you have in your local clone, we will tell Git to force the changes to the repo.		Once you have committed your changes to your local clone, you now have to put them where they can be seen: your fork. To ensure that your fork will match what you have in your local clone, we will tell Git to force the changes to the repo.
	*'''''git push -f fork master'''''		*'''''git push -f fork master'''''
			**Please note that using the -f option to force your changes causes Git to overwrite commit history on the repo. This option should only ever be used on personal forks to bring them into the same state as the main repo.
	If you have been working on and committing changes to music or client-data, you will need to push those to their respective forks.		If you have been working on and committing changes to music or client-data, you will need to push those to their respective forks.
	*'''''git push -f client-data master'''''		*'''''git push -f client-data master'''''
	*'''''git push -f music master'''''		*'''''git push -f music master'''''

Kandiman: /* Creating Remotes */

2012-06-09T18:22:28Z

Creating Remotes

← Older revision		Revision as of 18:22, 9 June 2012
Line 48:		Line 48:
	*Using the link we found at the end of the Creating a Fork section, issue the command '''''git remote add fork git@github.com:yournamehere/tmwa-server-data.git'''''		*Using the link we found at the end of the Creating a Fork section, issue the command '''''git remote add fork git@github.com:yournamehere/tmwa-server-data.git'''''

	We'll also need to add remote pointers ~~and choose the branch~~ for the submodules, if you cloned them.		We'll also need to add remote pointers for the submodules, if you cloned them.
	*'''''cd client-data'''''		*'''''cd client-data'''''
	*'''''git remote add client-data git@github.com:yournamehere/tmwa-client-data.git'''''		*'''''git remote add client-data git@github.com:yournamehere/tmwa-client-data.git'''''

Kandiman at 15:17, 9 June 2012

2012-06-09T15:17:42Z

← Older revision		Revision as of 15:17, 9 June 2012
Line 88:		Line 88:
	Once you have committed your changes to your local clone, you now have to put them where they can be seen: your fork. To ensure that your fork will match what you have in your local clone, we will tell Git to force the changes to the repo.		Once you have committed your changes to your local clone, you now have to put them where they can be seen: your fork. To ensure that your fork will match what you have in your local clone, we will tell Git to force the changes to the repo.
	*'''''git push -f fork master'''''		*'''''git push -f fork master'''''
			If you have been working on and committing changes to music or client-data, you will need to push those to their respective forks.
			*'''''git push -f client-data master'''''
			*'''''git push -f music master'''''

← Older revision		Revision as of 01:02, 13 June 2022
Line 19:		Line 19:
	Once you have installed Git, your first task should be to create a personal copy (also known as a fork) of the server data on your GitLab account. This will allow you to make changes and save them to a place where the content leaders can retrieve copies to include in the main server. It's also easier to work with.		Once you have installed Git, your first task should be to create a personal copy (also known as a fork) of the server data on your GitLab account. This will allow you to make changes and save them to a place where the content leaders can retrieve copies to include in the main server. It's also easier to work with.

	To create a fork, login to your GitLab account and go to the [https://~~gitlab~~.~~com/~~themanaworld/evolved/serverdata/ TMW Repository].		To create a fork, login to your GitLab account and go to the [https://git.themanaworld.org/evolved/serverdata/ TMW Repository].
	*You will see a button on the page that says Fork. Click it.		*You will see a button on the page that says Fork. Click it.
	*You should now see a page that has some details and history for the fork you just created. At the top will be a series of buttons including one that says SSH. Clicking the SSH button will create a link for you to copy which will be needed in the next step. It will look like ''git@gitlab.com:yournamehere/serverdata.git''. Copy that link or keep the page open; we'll need it later.		*You should now see a page that has some details and history for the fork you just created. At the top will be a series of buttons including one that says SSH. Clicking the SSH button will create a link for you to copy which will be needed in the next step. It will look like ''git@gitlab.com:yournamehere/serverdata.git''. Copy that link or keep the page open; we'll need it later.

	If you will be working with client-data or music, you will need to create separate forks for those repositories as well.		If you will be working with client-data or music, you will need to create separate forks for those repositories as well.
	*[https://~~gitlab~~.~~com/~~themanaworld/evolved/clientdata/ client-data]		*[https://git.themanaworld.org/evolved/clientdata/ client-data]
	*[https://gitlab.com/themanaworld/tmw-music/ music]		*[https://gitlab.com/themanaworld/tmw-music/ music]

Line 36:		Line 36:
	If you are using Linux, open a terminal window.		If you are using Linux, open a terminal window.
	*Navigate to the folder where you want to create your clone.		*Navigate to the folder where you want to create your clone.
	*Now issue the command to have Git create a copy: '''''git clone --recursive git://~~gitlab~~.~~com/~~themanaworld/evolved/serverdata.git serverdata'''''		*Now issue the command to have Git create a copy: '''''git clone --recursive git://git.themanaworld.org/evolved/serverdata.git serverdata'''''
	**The ''--recursive'' command tells Git to copy all of the data from the included submodules (client-data and music). If you don't plan on working with these, it can be omitted.		**The ''--recursive'' command tells Git to copy all of the data from the included submodules (client-data and music). If you don't plan on working with these, it can be omitted.
	** Currently, only TMWA has these as submodules, so it can also be omitted.		** Currently, only TMWA has these as submodules, so it can also be omitted.
	**The ''serverdata'' at the end of the command is the name of the folder you want the data in. In the example, ''git clone --recursive git://~~gitlab~~.~~com/~~themanaworld/evolved/serverdata.git serverdata'' will create a new folder called serverdata and put the files inside that folder. You can use any folder name that makes sense to you.		**The ''serverdata'' at the end of the command is the name of the folder you want the data in. In the example, ''git clone --recursive git://git.themanaworld.org/evolved/serverdata.git serverdata'' will create a new folder called serverdata and put the files inside that folder. You can use any folder name that makes sense to you.

	Note that copying the data may take some time.		Note that copying the data may take some time.