Difference between revisions of "Map Merger"

From /tg/station 13 Wiki
Jump to navigation Jump to search
(Update instructions for PR 55699)
(Add merge driver instructions)
Line 5: Line 5:
 
There are a few ways of running the tool. If you have trouble or need help, ask in [[Community|#coderbus]].
 
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) ==
+
'''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>
 
# '''Install the hook''': Open the <code>tools/hooks/</code> folder and double-click <code>Install.bat</code>
Line 12: Line 21:
 
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.
 
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 ==
+
=== Or: Run manually before committing ===
  
 
You can also manually run a .bat file just before each time you commit:
 
You can also manually run a .bat file just before each time you commit:
Line 20: Line 29:
 
# Commit
 
# Commit
  
−
== If you forgot to map merge ==
+
=== 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:
 
For first-time contributors who committed map edits without map merging, a script is available to automatically commit a fix to your PR branch:
Line 28: Line 37:
 
# Push your branch
 
# Push your branch
  
−
== What is map merging, actually? ==
+
== 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 ===
  
−
The "map merge" operation describes the process of converting a map file written by the DreamMaker map editor to:
+
# '''Install the hook''': Open the <code>tools/hooks/</code> folder and double-click <code>Install.bat</code>
−
# 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.
+
#* Linux users: run <code>tools/hooks/install.sh</code>
−
# 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.
+
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>
 +
 
 +
== Implementation details ==
  
 
Information on the tool's implementation is stored with [https://github.com/tgstation/tgstation/blob/master/tools/mapmerge2/ the code].
 
Information on the tool's implementation is stored with [https://github.com/tgstation/tgstation/blob/master/tools/mapmerge2/ the code].

Revision as of 01:25, 2 January 2021

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

Summary: for best results, open the tools/hooks/ folder and double-click Install.bat 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:

  1. 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.
  2. 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)

  1. Install the hook: Open the tools/hooks/ folder and double-click Install.bat
    • Linux users: run tools/hooks/install.sh

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:

  1. Ensure you have saved all your changes
  2. Open the tools/mapmerge2/ folder and double-click Run Before Committing.bat
  3. 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:

  1. Ensure you have no unsaved changes
  2. Open the tools/mapmerge2/ folder and double-click I Forgot To Map Merge.bat
  3. 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

  1. Install the hook: Open the tools/hooks/ folder and double-click Install.bat
    • Linux users: run tools/hooks/install.sh

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:

  1. Open the tools/mapmerge2/ folder and double-click Resolve Map Conflicts.bat
    • Linux users: run tools/hooks/dmm.merge --posthoc

Implementation details

Information on the tool's implementation is stored with the code.


Hosting Hosting a server • Setting up the database • Working with /tg/station as an upstream repository
Contributing Guide to contributing to the game • Setting up git • Downloading the source code • Reporting issues • Changelogs
Coding Understanding SS13 code • SS13 for experienced programmers • Code docs • Coding standards • Getting Your Pull Accepted • Binary flags‎ • Text Formatting • MySQL
Mapping Guide to mapping • Map merger • Guide to door access
Spriting Guide to spriting • Resolving icon conflicts
Wiki Guide to contributing to the wiki • Wikicode • Autowiki
Retrieved from "https://tgstation13.org/wiki/index.php?title=Map_Merger&oldid=35970"