Difference between revisions of "Map Merger"
SpaceManiac (talk | contribs) m |
SpaceManiac (talk | contribs) (Update instructions for PR 55658) |
||
| Line 3: | Line 3: | ||
/tg/station 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. | /tg/station 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 | + | There are a few ways of running the tool. If you have trouble or need help, ask in [[Community|#coderbus]]. |
| − | == | + | == Use as a Git hook == |
| − | # '''Install | + | # '''Install the hook''': Open the <code>tools/hooks</code> folder and double-click <code>Install.bat</code> |
| + | #* Linux users: run <code>tools/hooks/install.sh</code> | ||
| − | + | Once complete, the map merger will run '''automatically''' every time you commit in Git. The console log can be reviewed if there are any errors. | |
| − | + | == Fully manual method (not recommended) == | |
| − | + | This is the older method, and requires careful manual use each time you want to make changes to the map. First: | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | This is the older method, and | ||
| − | |||
| − | |||
Each time you want to edit a map, follow these steps: | Each time you want to edit a map, follow these steps: | ||
Revision as of 04:51, 23 December 2020
/tg/station 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 a few ways of running the tool. If you have trouble or need help, ask in #coderbus.
Use as a Git hook
- Install the hook: Open the
tools/hooksfolder and double-clickInstall.bat- Linux users: run
tools/hooks/install.sh
- Linux users: run
Once complete, the map merger will run automatically every time you commit in Git. The console log can be reviewed if there are any errors.
Fully manual method (not recommended)
This is the older method, and requires careful manual use each time you want to make changes to the map. First:
Each time you want to edit a map, follow these steps:
- Prepare maps: Run
tools/mapmerge2/Prepare Maps.batto 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.
- Run the map merger: Run
tools/mapmerge2/mapmerge.batand select the map you edited to merge.
With this method, 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 manually running the map merger or be extra-careful not to overwrite the changes the map merger made.
What is map merging, actually?
The "map merge" operation describes the process of converting a map file written by the DreamMaker map editor to:
- Use a format more amenable to Git's conflict resolution, called "TGM" and originally developed by Remie. The TGM map format is like the standard Dream Maker map format, but arranged differently, meaning Dream Maker is able to open TGM maps.
- Keep the size of the difference between the old version and the new version of the map as small as possible.
It requires an old version of the map to use as a reference and a new version of the map which contains the desired changes.
Information on the tool's implementation is stored with the code.