imported>SpaceManiac: Update instructions for PR 55699

2021-01-02T01:13:35Z

Update instructions for PR 55699

New page

: [[Guide to contributing to the game]] > [[Guide to mapping]]

/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 [[Community|#coderbus]].

== Use as a Git hook (recommended) ==

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

== Or: run manually before committing ==

You can also manually run a .bat file just before each time you commit:

# Ensure you have saved all your changes
# Open the <code>tools/mapmerge2/</code> folder and double-click <code>Run Before Committing.bat</code>
# Commit

== If you forgot to map merge ==

For first-time contributors who committed map edits without map merging, a script is available to automatically commit a fix to your PR branch:

# Ensure you have no unsaved changes
# Open the <code>tools/mapmerge2/</code> folder and double-click <code>I Forgot To Map Merge.bat</code>
# Push your branch

== 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 [https://github.com/tgstation/tgstation/blob/master/tools/mapmerge2/ the code].

{{Contribution guides}}

Map Merger - Revision history

imported>SpaceManiac: Update instructions for PR 55699