Map Merger - Revision history

Itsmeowdev: Latest from TG (Licensed CC-BY-NC-SA 4.0)

2023-03-29T03:19:29Z

Latest from TG (Licensed CC-BY-NC-SA 4.0)

@@ Line 1: / Line 1: @@
-beestation 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.
+BeeStation 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 the Discord.
-== Basic Setup ==
+'''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.
-# '''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.
+When run, the console output will indicate whether further manual action is needed, including conflicting coordinates.
-# '''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===
-# '''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>.
+#'''Install the hook''': Open the <code>tools/hooks/</code> folder and double-click <code>Install.bat</code>
-== Use as a Git Commit Hook (preferred) ==
+{{Contribution guides}}

Bluezorua: beestation not TG

2022-10-15T11:43:41Z

beestation not TG

← Older revision		Revision as of 11:43, 15 October 2022
Line 1:		Line 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.		beestation 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.

	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]].

imported>SpaceManiac: Update Python 3.7 information

2019-01-19T07:07:57Z

Update Python 3.7 information

← Older revision		Revision as of 07:07, 19 January 2019
Line 5:		Line 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.		# '''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.
	~~# '''If you installed Python 3.7~~ or ~~greater:''' Python 3.7 does not include pygit2, which means that you will have to install Visual C++: [https://aka~~.~~ms/buildtools Visual C++ Build Tools]~~
	# '''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>.		# '''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>.

imported>Denton: python 3.7 does not include pygit2, which makes it a giant pain in the ass since you're required to DL Visual C++ as well

2018-07-27T12:55:28Z

python 3.7 does not include pygit2, which makes it a giant pain in the ass since you're required to DL Visual C++ as well

← Older revision		Revision as of 12:55, 27 July 2018
Line 5:		Line 5:
	== Basic Setup ==		== Basic Setup ==

	# '''Install Python 3.6 ~~or greater~~''': If you don't already have Python installed, [https://www.python.org/downloads/ download and install] version 3.6 or greater.		# '''Install Python 3.6''': If you don't already have Python installed, [https://www.python.org/downloads/ download and install] version 3.6.
			# '''If you installed Python 3.7 or greater:''' Python 3.7 does not include pygit2, which means that you will have to install Visual C++: [https://aka.ms/buildtools Visual C++ Build Tools]
	# '''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>.		# '''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>.

imported>SpaceManiac: /* Use as a Git Commit Hook */ note

2018-07-25T07:46:12Z

Use as a Git Commit Hook: note

← Older revision		Revision as of 07:46, 25 July 2018
Line 9:		Line 9:
	# '''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>.		# '''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 ==		== Use as a Git Commit Hook (preferred) ==

	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.

imported>SpaceManiac: Prepare Maps has moved

2018-02-12T21:01:25Z

Prepare Maps has moved

← Older revision		Revision as of 21:01, 12 February 2018
Line 21:		Line 21:
	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. Each time you want to edit a map, follow these steps:

	# '''Prepare maps''': Run <code>tools/~~mapmerge~~/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.
	# '''Make your changes''': Don't forget to save.		# '''Make your changes''': Don't forget to save.
	# '''Exit DreamMaker''': Optional, but ensures that you don't accidentally undo the map merger's work.		# '''Exit DreamMaker''': Optional, but ensures that you don't accidentally undo the map merger's work.

imported>Oranges: fix syntax

2018-01-11T20:19:43Z

fix syntax

← Older revision		Revision as of 20:19, 11 January 2018
Line 6:		Line 6:

	# '''Install Python 3.6 or greater''': If you don't already have Python installed, [https://www.python.org/downloads/ download and install] version 3.6 or greater.		# '''Install Python 3.6 or greater''': If you don't already have Python installed, [https://www.python.org/downloads/ download and install] version 3.6 or greater.
	# '''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>.		# '''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>.

imported>Oranges: add back image

2018-01-11T20:19:15Z

add back image

← Older revision		Revision as of 20:19, 11 January 2018
Line 6:		Line 6:

	# '''Install Python 3.6 or greater''': If you don't already have Python installed, [https://www.python.org/downloads/ download and install] version 3.6 or greater.		# '''Install Python 3.6 or greater''': If you don't already have Python installed, [https://www.python.org/downloads/ download and install] version 3.6 or greater.
	# '''Ensure Python is in your PATH''': For Windows users, ensure that you check the "Add Python 3.6 to PATH" option in the installer.		# '''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>.		# '''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>.

imported>SpaceManiac: Rewrite for commit hook-based mapmerge

2017-12-29T01:33:47Z

Rewrite for commit hook-based mapmerge

← Older revision		Revision as of 01:33, 29 December 2017
Line 1:		Line 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.

	~~Before any change to a map, it is good to use~~ the ~~Map Merger tools. In a nutshell~~, ~~it rewrites the map to minimize differences between different versions~~ of ~~the map (DreamMakers map editor rewrites a lot of the tile keys)~~. ~~This makes the git diff between different map changes much smaller. More recently a new way of laying out the map was invented by Remie~~, ~~called TGM, this helps to further reduce conflicts~~ in ~~the map files~~.		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]].

	~~This is good for a few reasons~~		== Basic Setup ==

	~~1) Maintainers can actually verify the changes~~ you ~~are making are what~~ you ~~say they are by simply viewing~~ the ~~diff (~~For ~~small changes at least)~~		# '''Install Python 3.6 or greater''': If you don't already have Python installed, [https://www.python.org/downloads/ download and install] version 3.6 or greater.
			# '''Ensure Python is in your PATH''': For Windows users, ensure that you check the "Add Python 3.6 to PATH" option in the installer.
			# '''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>.

	2) The less changes there are in any given map diff, the easier it is for git to merge it without running into unexpected conflicts, which in most cases you have to either manually resolve or require you to remap your changes		== Use as a Git Commit Hook ==

			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.

	~~However - to do all this is going to require you to put some elbow grease into understanding~~ the ~~map merger tool~~.		# '''Install the hook''': Windows users run <code>tools/hooks/install.bat</code>. Other platforms run <code>tools/hooks/install.sh</code>.

	If you ~~have difficulty using these tools~~, ~~ask for help~~ in ~~[[Community\|#coderbus]]~~		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.

	== ~~Using the tools~~ ==		== Manual Use ==
	{\|
	\|-
	~~\|'''1. Install Python 3.5 or greater'''~~
	~~\|If you don't have Python already installed it can be downloaded from: https://www.python.org/downloads/ - make sure you grab the latest python 3, again, it must be 3.5 or greater~~
	\|-
	~~\|'''2. PATH Python'''~~
	~~\|This step is mostly applicable to windows users, you must make sure you ask the windows installer to add python to your path.~~
	\|-
	\|
	~~\|This image shows the correct setting to ensure is set https://file.house/DA6H.png~~
	\|-
	~~\|'''3. Prepare Maps'''~~
	~~\|Run "Prepare Maps.bat" in the tools/mapmerge/ directory.~~
	\|-
	~~\|'''4. Edit your map'''~~
	~~\|Make your changes to the map here. Remember to save them!~~
	\|-
	~~\|'''4a. Exit DreamMaker'''~~
	~~\|We're about to rewrite the entire MAP into a better format that works better with git, if DreamMaker is still open you may accidentally resave the map or autosave, undoing the next step.~~
	\|-
	~~\|'''5. Clean map'''~~
	~~\|Run "Run Map Merge - TGM.bat" in the tools/mapmerge/ directory.~~
	\|-
	~~\|'''7. Check differences'''~~
	~~\|Use your git application of choice to look at the differences between revisions of your code and commit the result.~~
	\|-
	~~\|'''8. Commit'''~~
	~~\|Your map is now ready to be committed, rejoice and wait for conflicts.~~
	\|}

	~~==Gotcha's==~~		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:
	*Reviewing the ~~map in dreammaker after mapmerging~~ but ~~before committing~~ changes to ~~git~~., ~~this will cause DreamMaker~~ to ~~rewrite it back~~ to the ~~dmm format, stage your maps with git add, then view in dreammaker~~ and ~~once~~ you~~'ve verified they look good, use git commit (not restaging)~~ to ~~commit the changes~~
	*Leaving DreamMaker ~~open while~~ running ~~mapmerger, can sometimes cause~~ DreamMaker to ~~write over~~ the ~~TGM's~~ changes		# '''Prepare maps''': Run <code>tools/mapmerge/Prepare Maps.bat</code> to save a backup of all maps in their current state.
	~~[[Category:Guides]] [[Category:Game Resources]]~~		# '''Make your changes''': Don't forget to save.
	~~{{Contribution guides}}~~		# '''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.

			== Gotchas ==

			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>Thot slayer: close dreammaker ffs

2017-10-23T22:46:04Z

close dreammaker ffs

← Older revision		Revision as of 22:46, 23 October 2017
Line 30:		Line 30:
	\|'''4. Edit your map'''		\|'''4. Edit your map'''
	\|Make your changes to the map here. Remember to save them!		\|Make your changes to the map here. Remember to save them!
			\|-
			\|'''4a. Exit DreamMaker'''
			\|We're about to rewrite the entire MAP into a better format that works better with git, if DreamMaker is still open you may accidentally resave the map or autosave, undoing the next step.
	\|-		\|-
	\|'''5. Clean map'''		\|'''5. Clean map'''
Line 40:		Line 43:
	\|Your map is now ready to be committed, rejoice and wait for conflicts.		\|Your map is now ready to be committed, rejoice and wait for conflicts.
	\|}		\|}


	==Gotcha's==		==Gotcha's==