Map Merger - Revision history

imported>SpaceManiac: Update Python 3.7 information

2019-01-19T07:07:57Z

Update Python 3.7 information

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

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

2018-07-25T07:46:12Z

Use as a Git Commit Hook: note

imported>SpaceManiac: Prepare Maps has moved

2018-02-12T21:01:25Z

Prepare Maps has moved

imported>Oranges: fix syntax

2018-01-11T20:19:43Z

fix syntax

imported>Oranges: add back image

2018-01-11T20:19:15Z

add back image

imported>SpaceManiac: Rewrite for commit hook-based mapmerge

2017-12-29T01:33:47Z

Rewrite for commit hook-based mapmerge

imported>Thot slayer: close dreammaker ffs

2017-10-23T22:46:04Z

close dreammaker ffs

imported>Oranges: /* Gotcha's */

2017-03-16T01:12:45Z

Gotcha's

imported>Oranges at 01:12, 16 March 2017

2017-03-16T01:12:22Z

@@ Line 5: / Line 5: @@
 == 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.
 # '''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>.

@@ Line 5: / Line 5: @@
 == 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.
 # '''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>.

@@ 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>.
-== 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.

@@ 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:
-# '''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.
 # '''Exit DreamMaker''': Optional, but ensures that you don't accidentally undo the map merger's work.

@@ 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.
-# '''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>.

@@ Line 1: / Line 1: @@
-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 ==
-) 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.
-) 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 ==
-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 ==
-==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.

@@ Line 30: / Line 30: @@
 |'''4. Edit your map'''
 |Make your changes to the map here. Remember to save them!
 |-
 |'''5. Clean map'''
@@ Line 40: / Line 43: @@
 |Your map is now ready to be committed, rejoice and wait for conflicts.
 |}
 ==Gotcha's==