Skip to content

Map Makers: Create a new map

Dan Van Atta edited this page Jan 30, 2016 · 2 revisions

Assuming you have a map zip you created, and tested, and things are looking good, and you want your name to be adopted into the game.

Determine repository name

What is your map name? To determine your repository name, lower case everything and replace spaces with underscores - this is the repository name. Note, the repository name internal only. The actual name of the map is set in the Map XMLs.

Create an empty remote repo and clone it

  • Create a new Repo, use the map repository name from above
  • Now clone it, Git will clone down what will be pretty much an empty folder.

Stage local files

  • Create a "map" folder insider of your new empty folder.
  • Extract all contents of your map zip into the "map" folder

Commit and push

  • Use git to add and commit the files, and push them

Map adoption

  • If the map is good, cut a ticket: https://github.com/triplea-maps/Project/issues/new, reference any source forge forum postings or other github issues that show the history of the map. Typically folks will create a forum post or issue for their new map, as a place to get user feedback when testing, and a place to give people a link to their latest map.
  • Transfer ownership of the repository to "triplea-game", (there's a button to do it in the Github Web UI, under your repository settings), for details on how please see: https://help.github.com/articles/transferring-a-repository)
  • If everything is good, the map admins will take incorporate the map. Builder bot and the map admins will be given write access to it, and automated "zip" file build will then be added (no more needing to zip your map files yourself). You'll be added as an 'owner' of the map, you'll be able to give other people write access to your map, if you want them to be able to directly make changes to it.

Pull Requests

Changes to repositories which you do not own are done via "pull requests". You fork the repository you want changed, you change your fork, then you submit a pull request back to the original repository. The original repository owners can then accept or reject your changes. Anybody in the world will be able to submit one of these requests against your map, and you will be in charge of accepting or rejecting them too (and anyone else with write access will be able to do similar, map admins included)