Map Merger: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Veeblefetzer (talk | contribs) (Adds disclaimer on python version not being definite. See https://discord.com/channels/134720091576205312/825400622852603914/830551839056986184) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
This is required for a few reasons: | This is required for a few reasons: | ||
# 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]. | If you have difficulty using these tools, ask for help in [https://discord.gg/0keg6hQH05Ha8OfO #mapping]. | ||
| Line 14: | Line 12: | ||
{| | {| | ||
|- | |- | ||
|'''1. Install Python 3.7''' | |'''1. Install Python 3.7''' | ||
|It can be found [https://www.python.org/downloads/ here]. | |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 to add python to your path. [https://file.house/DA6H.png There will be an option for this when you install python.] | |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. | |'''3. Prepare Maps''' | ||
|Run "Prepare Maps.bat" in the \tools\mapmerge2 directory. | |Run "Prepare Maps.bat" in the \tools\mapmerge2 directory. | ||
|- | |- | ||
Latest revision as of 05:24, 11 April 2021
Before you PR any change to a map, you need to use the Map Merger tools.
This is required for a few reasons:
- 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 #mapping.
Using mapmerger
| 1. Install Python 3.7 | It can be found here. Future versions of Python may or may not work, the following guide was tested with Python 3.7. |
| 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. 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 |