Skip to content

Update Triplea_maps.yaml

Dan Van Atta edited this page Jun 6, 2016 · 4 revisions

Submit a PR with an update to this file: https://github.com/triplea-maps/Project/blob/master/production_config/triplea_maps.yaml

Head to that URL, click the pencil icon to edit it from your web browser. Github will guide you in creating a fork, so you can focus on the update you want to make. To update the file:

Find this line:

- mapName: ==IN DEVELOPMENT==

From there start scrolling down, and notice the map names that scroll by, for example:

  mapName: Domination_1914_Blood_And_Steel

Insert your map in rough alphabetical order. This is only done so you do not get merge conflicts. When the map name is marked with "==", it is a "header" or a "section". Everything in between two headers is sorted alphabetically by the engine, so it actually does not really matter where you insert your map. Just it matters that you insert it correctly.

To insert / update triplea_maps.yaml

You'll need 4 things: url, mapName, description, and version.

URL should start with a "-" , this denotes a new list element. For example: - url: https://github.com/triplea-maps/domination_1914_blood_and_steel/releases/download/0.1/domination_1914_blood_and_steel.zip

This URL is where to find your map. Head to your map homepage, find the "releases" link, (or add /releases to the end of the URL), and copy paste the link of the map file of the latest release.

The next thing is "mapName". Indentation is the only thing to watch out for. The "m" on "mapName" needs to line up with "url". The value of the "mapName" is whatever you wish it to be, it does not need to match the map zip, though it typically does or is close (your mapName may contain spaces, this is the name that is displayed to players, not used internally by the game engine. Do not include special characters, that is just tempting fate too much, but dashes are fine, and quotes should be fine too).

For example:

- url: https://github.com/triplea-maps/domination_1914_blood_and_steel/releases/download/0.1/domination_1914_blood_and_steel.zip`
  mapName: Domination 1914 Blood And Steel

Last comes description, for this follow examples of the previous block, start with:

  description: |

Then make sure everything starts at the same indentation level there-after. For example:

- url: https://github.com/triplea-maps/domination_1914_blood_and_steel/releases/download/0.1/domination_1914_blood_and_steel.zip
  mapName: Domination_1914_Blood_And_Steel
  description: |
    <img src="http://tripleamaps.sourceforge.net/images/TripleA_domination_1914_blood_and_steel_mini.png" /> 
    <br>
    <br>Domination_1914_Blood_And_Steel 
    <br>by Navalland 

Last, is "version", which will finish up the block. After your block you should see the start of another that begins with a new "- url".

A finished example will look like this in the end:

- url: https://github.com/triplea-maps/domination_1914_blood_and_steel/releases/download/0.1/domination_1914_blood_and_steel.zip
  mapName: Domination_1914_Blood_And_Steel
  description: |
    <img src="http://tripleamaps.sourceforge.net/images/TripleA_domination_1914_blood_and_steel_mini.png" /> 
    <br>
    <br>Domination_1914_Blood_And_Steel 
    <br>by Navalland 
    <br>Version 1.0 for TripleA 1.8.0.5 
    <br>Suggestions to [email protected] 
    <br>
    <br>"Domination 1914 Blood And Steel" is a realistic First World War immersive grand strategy wargame, based on the military conflict between two opposite sides. Germany, Austria, Ottomans, Bulgaria and Bolsheviks are Central Powers. Americans, British, French, Russia, Serbia, Romania, Greece and Japan are Allied. The various countries join the war at different times. Italy can join Central Powers or Allied, depending on Central Powers' achievements. 
    <br>
    <br>Available politic panel and actions to declare war on some neutral countries. Different units for different countries. And different technologies for different countries. Featuring convoy zones, harbours, airfields and dogfighting. 
    <br>
    <br>Highly dynamic gameplay. The war extending over the immense spaces of Africa, East Asia and Pacific, yet of scarce or no economic value. Europe is where the future of the World shall be forged, with steel and blood... 
    <br>        
  version: 1.0

Start the version at 1.0. It's a bit of a debate how to maintain this version number.. Hopefully there will be some updates on that, for now it's not terribly important that it is updated, but perhaps good to update it when the map is drastically improves/different.. that is the best guidance for the moment, increment it on major releases and bump the major version, so the next version would be "2.0"