imported>Cartographer-D: Added a note to the in-progress merges section to clarify what needs to be done for the bat file to work.

2021-01-11T05:24:17Z

Added a note to the in-progress merges section to clarify what needs to be done for the bat file to work.

Новая страница

: [[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]].

'''Summary''': for best results, open the <code>tools/hooks/</code> folder and double-click <code>Install.bat</code> to install the hooks, which will handle things automatically.

== TGM format conversion ==

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.
This is accomplished by referencing the changed version of the map against the old version stored in the Git history.

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

== Automatic conflict resolver ==

We also have a rudimentary conflict resolver to cover some cases that the TGM conversion couldn't prevent.

When run, the console output will indicate whether further manual action is needed, including conflicting coordinates.

=== Use as a Git hook ===

# '''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 conflict resolver will run '''automatically''' every time you merge in Git.

=== Or: Resolve conflicts on an in-progress merge ===

If you are using a Git GUI which does not run the hook on merge, you can also run the conflict resolver on an in-progress merge by request:
# Open the <code>tools/mapmerge2/</code> folder and double-click <code>Resolve Map Conflicts.bat</code>
#* Linux users: run <code>tools/hooks/dmm.merge --posthoc</code>

Note that to use this, you must merge your updated local master branch into the branch with conflicts so that your Git GUI reports a conflict on the map file.
== Implementation details ==

Information on the tool's implementation is stored with [https://github.com/tgstation/tgstation/blob/master/tools/mapmerge2/ the code].

{{Contribution guides}}

Map Merger - История изменений

imported>Cartographer-D: Added a note to the in-progress merges section to clarify what needs to be done for the bat file to work.