Map Merger: Difference between revisions

From Yogstation-13
Jump to navigation Jump to search
imported>Oranges
m (details)
No edit summary
Line 1: Line 1:
'''Before you PR any change to a map, you need to use the Map Merger tools.'''


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.
This is required for a few reasons:


This is good for a few reasons
1) 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.


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)
2) 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).


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


If you have difficulty using these tools, ask for help in [https://discord.gg/0keg6hQH05Ha8OfO #mapping].


However - to do all this is going to require you to put some elbow grease into understanding the map merger tool.
==Using mapmerger==
 
If you have difficulty using these tools, ask for help in [[Community|#coderbus]]
 
== Using the tools ==
{|
{|
|-
|-
|'''1. Install Python 3.5 or greater'''
|'''1. Install Python 3.7'''
|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
|It can be found [https://www.python.org/downloads/ here].
|-
|-
|'''2. PATH Python'''
|'''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 step is mostly applicable to windows users, you must make sure to add python to your path. [https://file.house/DA6H.png There will be an option for this when you install python.]
|-
|
|This image shows the correct setting to ensure is set https://file.house/DA6H.png
|-
|-
|'''3. Prepare Maps'''
|'''3. (Optional) Prepare Maps'''
|Run "Prepare Maps.bat" in the tools/mapmerge/ directory.
|Run "Prepare Maps.bat" in the \tools\mapmerge2 directory.
|-
|-
|'''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 and compile!
|-
|-
|'''5. Clean map'''
|'''5. Clean map'''
|Run "Run Map Merge - TGM.bat" in the tools/mapmerge/ directory.  
|Run "mapmerge.bat" in the \tools\mapmerge2 directory. Scroll through the list and type the appropriate map number(s).
|-
|-
|'''7. Check differences'''
|'''7. Check differences'''
Line 38: Line 33:
|-
|-
|'''8. Commit'''
|'''8. Commit'''
|Your map is now ready to be committed, rejoice and wait for conflicts.
|Your map is now ready to be committed.
|}
|}


[[Category:Guides]] [[Category:Game Resources]]
[[Category:Guides]] [[Category:Game Resources]]
{{Contribution guides}}
{{Contribution guides}}

Revision as of 23:32, 30 December 2019

Before you PR any change to a map, you need to use the Map Merger tools.

This is required for a few reasons:

1) 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.

2) 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).

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.

If you have difficulty using these tools, ask for help in #mapping.

Using mapmerger

1. Install Python 3.7 It can be found here.
2. PATH Python This step is mostly applicable to windows users, you must make sure to add python to your path. There will be an option for this when you install python.
3. (Optional) Prepare Maps Run "Prepare Maps.bat" in the \tools\mapmerge2 directory.
4. Edit your map Make your changes to the map here. Remember to save them and compile!
5. Clean map Run "mapmerge.bat" in the \tools\mapmerge2 directory. Scroll through the list and type the appropriate map number(s).
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.
Contribution guides
General Hosting a server, Setting up git, Guide to GitKraken, Downloading the source code, Guide to contributing to the game, Reporting issues, Game resources category, Guide to changelogs
Database (MySQL) Setting up the database, MySQL
Coding Understanding SS13 code, SS13 for experienced programmers, Text Formatting
Mapping Guide to mapping, Room Structure, Map merger
Spriting Guide to spriting
Wiki Guide to contributing to the wiki, Wikicode, Styleguide
Retrieved from "https://wiki.yogstation.net/index.php?title=Map_Merger&oldid=29972"