Difference between revisions of "Map Merger"

From /tg/station 13 Wiki
Jump to navigation Jump to search
(Update instructions for PR 55658)
(Update instructions for PR 55699)
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 ==
+
== 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>
 
#* Linux users: run <code>tools/hooks/install.sh</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.
 
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) ==
+
== Or: run manually before committing ==
  
−
This is the older method, and requires careful manual use each time you want to make changes to the map. First:
+
You can also manually run a .bat file just before each time you commit:
  
−
Each time you want to edit a map, follow these steps:
+
# Ensure you have saved all your changes
 +
# Open the <code>tools/mapmerge2/</code> folder and double-click <code>Run Before Committing.bat</code>
 +
# Commit
  
−
# '''Prepare maps''': Run <code>tools/mapmerge2/Prepare Maps.bat</code> to save a backup of all maps in their current state.
+
== If you forgot to map merge ==
−
# '''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 <code>tools/mapmerge2/mapmerge.bat</code> and 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.
+
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? ==
 
== What is map merging, actually? ==

Revision as of 01:13, 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.

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

What is map merging, actually?

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.

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.


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