833
edits
imported>Oranges m (details) |
Veeblefetzer (talk | contribs) (Adds disclaimer on python version not being definite. See https://discord.com/channels/134720091576205312/825400622852603914/830551839056986184) |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
'''Before you PR any change to a map, you need to use the Map Merger tools.''' | |||
This is required for a few reasons: | |||
This is | # 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. | ||
# 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). | |||
# 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]. | |||
==Using mapmerger== | |||
== Using | |||
{| | {| | ||
|- | |- | ||
|'''1. Install Python 3. | |'''1. Install Python 3.7''' | ||
| | |It can be found [https://www.python.org/downloads/ here]. Future versions of Python may or may not work, the following guide was tested with Python 3.7. | ||
|- | |- | ||
|'''2. PATH Python''' | |'''2. PATH Python''' | ||
|This step is mostly applicable to windows users, you must make sure | |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.] | ||
|- | |- | ||
|'''3. Prepare Maps''' | |'''3. Prepare Maps''' | ||
|Run "Prepare Maps.bat" in the tools | |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 "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 31: | ||
|- | |- | ||
|'''8. Commit''' | |'''8. Commit''' | ||
|Your map is now ready to be committed | |Your map is now ready to be committed. | ||
|} | |} | ||
[[Category:Guides]] [[Category:Game Resources]] | [[Category:Guides]] [[Category:Game Resources]] | ||
{{Contribution guides}} | {{Contribution guides}} |
edits