Map Merger - История изменений

imported>San7890: Adds link to the Guide to Mapping for Git Hooks.

2022-07-25T03:46:26Z

Adds link to the Guide to Mapping for Git Hooks.

← Предыдущая версия		Версия от 03:46, 25 июля 2022
Строка 3:		Строка 3:
	/tg/station uses a tool called the '''Map Merger''' to make map changes easier for maintainers to review and less likely to conflict with map changes made by others.		/tg/station uses a tool called the '''Map Merger''' to make map changes easier for maintainers to review and less likely to conflict with map changes made by others.

	There are a few ways of running the tool. If you have trouble or need help, ask in [[Community\|#coderbus]].		There are a few ways of running the tool. If you have trouble or need help, ask in [[Community\|#coderbus]]. You may find a visual guide [https://hackmd.io/@tgstation/SyVma0dS5#Git-Hooks here].

	'''Summary''': for best results, open the <code>tools/hooks/</code> folder and double-click <code>Install.bat</code> to install the hooks, which will handle things automatically.		'''Summary''': for best results, open the <code>tools/hooks/</code> folder and double-click <code>Install.bat</code> to install the hooks, which will handle things automatically.

imported>Cartographer-D: Added a note to the in-progress merges section to clarify what needs to be done for the bat file to work.

2021-01-11T05:24:17Z

Added a note to the in-progress merges section to clarify what needs to be done for the bat file to work.

← Предыдущая версия		Версия от 05:24, 11 января 2021
Строка 56:		Строка 56:
	#* Linux users: run <code>tools/hooks/dmm.merge --posthoc</code>		#* Linux users: run <code>tools/hooks/dmm.merge --posthoc</code>

			Note that to use this, you must merge your updated local master branch into the branch with conflicts so that your Git GUI reports a conflict on the map file.
	== Implementation details ==		== Implementation details ==

imported>SpaceManiac: Add merge driver instructions

2021-01-02T01:25:27Z

Add merge driver instructions

← Предыдущая версия		Версия от 01:25, 2 января 2021
Строка 5:		Строка 5:
	There are a few ways of running the tool. If you have trouble or need help, ask in [[Community\|#coderbus]].		There are a few ways of running the tool. If you have trouble or need help, ask in [[Community\|#coderbus]].

	== Use as a Git hook (recommended) ==		'''Summary''': for best results, open the <code>tools/hooks/</code> folder and double-click <code>Install.bat</code> to install the hooks, which will handle things automatically.

			== TGM format conversion ==

			The "map merge" operation describes the process of converting a map file written by the DreamMaker map editor to:
			# Use a format more amenable to Git's conflict resolution, called "TGM" and originally developed by Remie. The TGM map format is like the standard Dream Maker map format, but arranged differently, meaning Dream Maker is able to open TGM maps.
			# Keep the size of the difference between the old version and the new version of the map as small as possible.
			This is accomplished by referencing the changed version of the map against the old version stored in the Git history.

			=== Use as a Git hook (recommended) ===

	# '''Install the hook''': Open the <code>tools/hooks/</code> folder and double-click <code>Install.bat</code>		# '''Install the hook''': Open the <code>tools/hooks/</code> folder and double-click <code>Install.bat</code>
Строка 12:		Строка 21:
	Once complete, the map merger will run '''automatically''' every time you commit in Git. The console log can be reviewed if there are any errors.		Once complete, the map merger will run '''automatically''' every time you commit in Git. The console log can be reviewed if there are any errors.

	== Or: ~~run~~ manually before committing ==		=== Or: Run manually before committing ===

	You can also manually run a .bat file just before each time you commit:		You can also manually run a .bat file just before each time you commit:
Строка 20:		Строка 29:
	# Commit		# Commit

	== If you forgot to map merge ==		=== If you forgot to map merge ===

	For first-time contributors who committed map edits without map merging, a script is available to automatically commit a fix to your PR branch:		For first-time contributors who committed map edits without map merging, a script is available to automatically commit a fix to your PR branch:
Строка 28:		Строка 37:
	# Push your branch		# Push your branch

	== ~~What~~ is ~~map merging~~, ~~actually?~~ ==		== Automatic conflict resolver ==

			We also have a rudimentary conflict resolver to cover some cases that the TGM conversion couldn't prevent.

			When run, the console output will indicate whether further manual action is needed, including conflicting coordinates.

			=== Use as a Git hook ===

	~~The "map merge" operation describes~~ the ~~process of converting a map file written by~~ the ~~DreamMaker map editor to~~:		# '''Install the hook''': Open the <code>tools/hooks/</code> folder and double-click <code>Install.bat</code>
	~~# Use~~ a ~~format more amenable to~~ Git's conflict ~~resolution, called "TGM" and originally developed~~ by ~~Remie. The TGM map format is like the standard Dream Maker map format, but arranged differently, meaning Dream Maker is able to open TGM maps.~~		#* Linux users: run <code>tools/hooks/install.sh</code>
	# ~~Keep~~ the ~~size of the difference between the old version~~ and ~~the new version of the map as small as possible~~.
	~~It requires an old version of the map to use as a reference and a new version of the map which contains the desired changes~~.		Once complete, the conflict resolver will run '''automatically''' every time you merge in Git.

			=== Or: Resolve conflicts on an in-progress merge ===

			If you are using a Git GUI which does not run the hook on merge, you can also run the conflict resolver on an in-progress merge by request:
			# Open the <code>tools/mapmerge2/</code> folder and double-click <code>Resolve Map Conflicts.bat</code>
			#* Linux users: run <code>tools/hooks/dmm.merge --posthoc</code>

			== Implementation details ==

	Information on the tool's implementation is stored with [https://github.com/tgstation/tgstation/blob/master/tools/mapmerge2/ the code].		Information on the tool's implementation is stored with [https://github.com/tgstation/tgstation/blob/master/tools/mapmerge2/ the code].

imported>SpaceManiac: Update instructions for PR 55699

2021-01-02T01:13:35Z

Update instructions for PR 55699

← Предыдущая версия		Версия от 01:13, 2 января 2021
Строка 5:		Строка 5:
	There are a few ways of running the tool. If you have trouble or need help, ask in [[Community\|#coderbus]].		There are a few ways of running the tool. If you have trouble or need help, ask in [[Community\|#coderbus]].

	== Use as a Git hook ==		== Use as a Git hook (recommended) ==

	# '''Install the hook''': Open the <code>tools/hooks</code> folder and double-click <code>Install.bat</code>		# '''Install the hook''': Open the <code>tools/hooks/</code> folder and double-click <code>Install.bat</code>
	#* Linux users: run <code>tools/hooks/install.sh</code>		#* Linux users: run <code>tools/hooks/install.sh</code>

	Once complete, the map merger will run '''automatically''' every time you commit in Git. The console log can be reviewed if there are any errors.		Once complete, the map merger will run '''automatically''' every time you commit in Git. The console log can be reviewed if there are any errors.

	== ~~Fully manual method (not recommended)~~ ==		== Or: run manually before committing ==

	~~This is the older method, and requires careful manual use~~ each time you ~~want to make changes to the map. First~~:		You can also manually run a .bat file just before each time you commit:

	~~Each time~~ you ~~want to edit a map, follow these steps:~~		# Ensure you have saved all your changes
			# Open the <code>tools/mapmerge2/</code> folder and double-click <code>Run Before Committing.bat</code>
			# Commit

	~~# '''Prepare maps''': Run <code>tools/mapmerge2/Prepare Maps.bat</code> to save a backup of all maps in their current state.~~		== If you forgot to map merge ==
	~~# '''Make your changes''': Don't forget~~ to ~~save.~~
	~~# '''Exit DreamMaker''': Optional, but ensures that you don't accidentally undo the~~ map ~~merger's work.~~
	~~# '''Run the map merger''': Run <code>tools/mapmerge2/mapmerge.bat</code> and select the map you edited to~~ merge.

	~~With this method, leaving the~~ map ~~open in DreamMaker or reviewing it after running the~~ map ~~merger makes it possible~~ to ~~accidentally save and overwrite the merged map with an unmerged map. Close DreamMaker entirely before manually running the map merger or be extra-careful not~~ to ~~overwrite the~~ changes the ~~map merger made~~.		For first-time contributors who committed map edits without map merging, a script is available to automatically commit a fix to your PR branch:

			# Ensure you have no unsaved changes
			# Open the <code>tools/mapmerge2/</code> folder and double-click <code>I Forgot To Map Merge.bat</code>
			# Push your branch

	== What is map merging, actually? ==		== What is map merging, actually? ==

imported>SpaceManiac: Update instructions for PR 55658

2020-12-23T04:51:30Z

Update instructions for PR 55658

← Предыдущая версия		Версия от 04:51, 23 декабря 2020
Строка 3:		Строка 3:
	/tg/station uses a tool called the '''Map Merger''' to make map changes easier for maintainers to review and less likely to conflict with map changes made by others.		/tg/station uses a tool called the '''Map Merger''' to make map changes easier for maintainers to review and less likely to conflict with map changes made by others.

	There are ~~two~~ ways of running the tool~~, each requiring some amount of setup~~. If you have trouble or need help, ask in [[Community\|#coderbus]].		There are a few ways of running the tool. If you have trouble or need help, ask in [[Community\|#coderbus]].

	== ~~Basic setup~~ ==		== Use as a Git hook ==

	# '''Install ~~Python~~''': ~~If you don't already have Python installed, [https:~~//~~www~~.~~python.org~~/~~downloads~~/ ~~download and~~ install~~] the latest version~~.		# '''Install the hook''': Open the <code>tools/hooks</code> folder and double-click <code>Install.bat</code>
			#* Linux users: run <code>tools/hooks/install.sh</code>

	~~== Use as a~~ Git ~~hook (recommended) ==~~		Once complete, the map merger will run '''automatically''' every time you commit in Git. The console log can be reviewed if there are any errors.

	~~# '''Install the hook''': Windows users open the <code>tools/hooks</code> folder and double-click <code>install.bat</code>. Other platforms run <code>tools/hooks/install.sh</code>.~~		== Fully manual method (not recommended) ==

	~~Once the Git hook is installed, no further manual intervention is needed and the map merger will run automatically any time you commit in Git.~~		This is the older method, and requires careful manual use each time you want to make changes to the map. First:

	The dialog box or console output of the commit will show the map merger's log. You can check the git commit log to review changes, or run <code>tools/mapmerge2/precommit.py</code> manually to review changes before committing.

	~~== Run manually (not recommended) ==~~

	This is the older method, and ~~is simpler but~~ requires careful manual use each time you want to make changes to the map. First:

	# '''Install dependencies''': For Windows users, run <code>tools/mapmerge2/requirements-install.bat</code>. Non-Windows or advanced users can manually run <code>python -m pip install tools/mapmerge2/requirements.txt</code>.

	Each time you want to edit a map, follow these steps:		Each time you want to edit a map, follow these steps:

imported>SpaceManiac в 03:42, 30 ноября 2020

2020-11-30T03:42:36Z

← Предыдущая версия		Версия от 03:42, 30 ноября 2020
Строка 40:		Строка 40:

	Information on the tool's implementation is stored with [https://github.com/tgstation/tgstation/blob/master/tools/mapmerge2/ the code].		Information on the tool's implementation is stored with [https://github.com/tgstation/tgstation/blob/master/tools/mapmerge2/ the code].


			{{Contribution guides}}

imported>SpaceManiac в 03:39, 30 ноября 2020

2020-11-30T03:39:27Z

← Предыдущая версия		Версия от 03:39, 30 ноября 2020
Строка 1:		Строка 1:
	/tg/station uses a tool called the '''Map Merger''' to ~~minimize differences between versions of maps and lay them out in a format known as TGM, developed by Remie. This makes~~ changes easier for maintainers to review and less likely to conflict with changes made by others.		: [[Guide to contributing to the game]] > [[Guide to mapping]]

			/tg/station uses a tool called the '''Map Merger''' to make map changes easier for maintainers to review and less likely to conflict with map changes made by others.

	There are two ways of running the tool, each requiring some amount of setup. If you have trouble or need help, ask in [[Community\|#coderbus]].		There are two ways of running the tool, each requiring some amount of setup. If you have trouble or need help, ask in [[Community\|#coderbus]].

	== Basic ~~Setup~~ ==		== Basic setup ==

	# '''Install Python''': If you don't already have Python installed, [https://www.python.org/downloads/ download and install] the latest version.		# '''Install Python''': If you don't already have Python installed, [https://www.python.org/downloads/ download and install] the latest version.
Строка 29:		Строка 31:

	With this method, leaving the map open in DreamMaker or reviewing it after running the map merger makes it possible to accidentally save and overwrite the merged map with an unmerged map. Close DreamMaker entirely before manually running the map merger or be extra-careful not to overwrite the changes the map merger made.		With this method, leaving the map open in DreamMaker or reviewing it after running the map merger makes it possible to accidentally save and overwrite the merged map with an unmerged map. Close DreamMaker entirely before manually running the map merger or be extra-careful not to overwrite the changes the map merger made.

			== What is map merging, actually? ==

			The "map merge" operation describes the process of converting a map file written by the DreamMaker map editor to:
			# Use a format more amenable to Git's conflict resolution, called "TGM" and originally developed by Remie. The TGM map format is like the standard Dream Maker map format, but arranged differently, meaning Dream Maker is able to open TGM maps.
			# Keep the size of the difference between the old version and the new version of the map as small as possible.
			It requires an old version of the map to use as a reference and a new version of the map which contains the desired changes.

			Information on the tool's implementation is stored with [https://github.com/tgstation/tgstation/blob/master/tools/mapmerge2/ the code].

imported>SpaceManiac: we can now detect python more reliably than before

2020-09-09T05:06:47Z

we can now detect python more reliably than before

← Предыдущая версия		Версия от 05:06, 9 сентября 2020
Строка 5:		Строка 5:
	== Basic Setup ==		== Basic Setup ==

	# '''Install Python ~~3.6~~''': If you don't already have Python installed, [https://www.python.org/downloads/ download and install] version ~~3.6 or later~~.		# '''Install Python''': If you don't already have Python installed, [https://www.python.org/downloads/ download and install] the latest version.
	~~# '''Ensure Python is in your PATH''': For Windows users, ensure that you check the "Add Python 3.6 to PATH" option in the installer. - see [https://file.house/DA6H.png here for example]~~

	== Use as a Git hook (recommended) ==		== Use as a Git hook (recommended) ==

imported>SpaceManiac: More improvements

2020-06-26T18:54:41Z

More improvements

← Предыдущая версия		Версия от 18:54, 26 июня 2020
Строка 8:		Строка 8:
	# '''Ensure Python is in your PATH''': For Windows users, ensure that you check the "Add Python 3.6 to PATH" option in the installer. - see [https://file.house/DA6H.png here for example]		# '''Ensure Python is in your PATH''': For Windows users, ensure that you check the "Add Python 3.6 to PATH" option in the installer. - see [https://file.house/DA6H.png here for example]

	== Use as a Git ~~Commit Hook~~ (~~preferred~~) ==		== Use as a Git hook (recommended) ==

	~~This method requires slightly more setup,~~ and ~~requires you to be using git rather than just downloading the source, but requires no manual intervention after setup~~. ~~For this reason, it is the recommended method~~.		# '''Install the hook''': Windows users open the <code>tools/hooks</code> folder and double-click <code>install.bat</code>. Other platforms run <code>tools/hooks/install.sh</code>.

	~~# '''Install~~ the hook~~''': Windows users open~~ the ~~<code>tools/hooks</code> folder and double-click <code>install.bat</code>. Other platforms~~ run ~~<code>tools/hooks/install.sh</code>~~.		Once the Git hook is installed, no further manual intervention is needed and the map merger will run automatically any time you commit in Git.

	~~Now, any time you create a commit, the map merger runs automatically and bases your changes on top of the previous version of the map stored in git.~~ The dialog box or console output of the commit will show the map merger's log. You can check the git commit log to review changes, or run <code>tools/mapmerge2/precommit.py</code> manually to review changes before ~~comitting~~.		The dialog box or console output of the commit will show the map merger's log. You can check the git commit log to review changes, or run <code>tools/mapmerge2/precommit.py</code> manually to review changes before committing.

	== ~~Manual Use~~ ==		== Run manually (not recommended) ==

	This is the older method, and is simpler but requires careful manual use each time you want to make changes to the map. First:		This is the older method, and is simpler but requires careful manual use each time you want to make changes to the map. First:
Строка 29:		Строка 29:
	# '''Run the map merger''': Run <code>tools/mapmerge2/mapmerge.bat</code> and select the map you edited to merge.		# '''Run the map merger''': Run <code>tools/mapmerge2/mapmerge.bat</code> and select the map you edited to merge.

	~~== Gotchas ==~~		With this method, leaving the map open in DreamMaker or reviewing it after running the map merger makes it possible to accidentally save and overwrite the merged map with an unmerged map. Close DreamMaker entirely before manually running the map merger or be extra-careful not to overwrite the changes the map merger made.

	~~Leaving~~ the map open in DreamMaker or reviewing it after running the map merger makes it possible to accidentally save and overwrite the merged map with an unmerged map. Close DreamMaker entirely before running the map merger or be extra-careful not to overwrite the changes the map merger made.

imported>SpaceManiac: Make instructions easier to understand

2020-06-26T18:45:07Z

Make instructions easier to understand

← Предыдущая версия		Версия от 18:45, 26 июня 2020
Строка 7:		Строка 7:
	# '''Install Python 3.6''': If you don't already have Python installed, [https://www.python.org/downloads/ download and install] version 3.6 or later.		# '''Install Python 3.6''': If you don't already have Python installed, [https://www.python.org/downloads/ download and install] version 3.6 or later.
	# '''Ensure Python is in your PATH''': For Windows users, ensure that you check the "Add Python 3.6 to PATH" option in the installer. - see [https://file.house/DA6H.png here for example]		# '''Ensure Python is in your PATH''': For Windows users, ensure that you check the "Add Python 3.6 to PATH" option in the installer. - see [https://file.house/DA6H.png here for example]
	# '''Install dependencies''': For Windows users, run <code>tools/mapmerge2/requirements-install.bat</code>. Non-Windows or advanced users can manually run <code>python -m pip install tools/mapmerge2/requirements.txt</code>.

	== Use as a Git Commit Hook (preferred) ==		== Use as a Git Commit Hook (preferred) ==
Строка 13:		Строка 12:
	This method requires slightly more setup, and requires you to be using git rather than just downloading the source, but requires no manual intervention after setup. For this reason, it is the recommended method.		This method requires slightly more setup, and requires you to be using git rather than just downloading the source, but requires no manual intervention after setup. For this reason, it is the recommended method.

	# '''Install the hook''': Windows users ~~run~~ <code>tools/hooks/install.bat</code>. Other platforms run <code>tools/hooks/install.sh</code>.		# '''Install the hook''': Windows users open the <code>tools/hooks</code> folder and double-click <code>install.bat</code>. Other platforms run <code>tools/hooks/install.sh</code>.

	Now, any time you create a commit, the map merger runs automatically and bases your changes on top of the previous version of the map stored in git. The dialog box or console output of the commit will show the map merger's log. You can check the git commit log to review changes, or run <code>tools/mapmerge2/precommit.py</code> manually to review changes before comitting.		Now, any time you create a commit, the map merger runs automatically and bases your changes on top of the previous version of the map stored in git. The dialog box or console output of the commit will show the map merger's log. You can check the git commit log to review changes, or run <code>tools/mapmerge2/precommit.py</code> manually to review changes before comitting.
Строка 19:		Строка 18:
	== Manual Use ==		== Manual Use ==

	This is the older method, and is simpler but requires careful manual use each time you want to make changes to the map. Each time you want to edit a map, follow these steps:		This is the older method, and is simpler but requires careful manual use each time you want to make changes to the map. First:

			# '''Install dependencies''': For Windows users, run <code>tools/mapmerge2/requirements-install.bat</code>. Non-Windows or advanced users can manually run <code>python -m pip install tools/mapmerge2/requirements.txt</code>.

			Each time you want to edit a map, follow these steps:

	# '''Prepare maps''': Run <code>tools/mapmerge2/Prepare Maps.bat</code> to save a backup of all maps in their current state.		# '''Prepare maps''': Run <code>tools/mapmerge2/Prepare Maps.bat</code> to save a backup of all maps in their current state.