Map Submission Guide - OresomeCraft/MapsPlugin GitHub Wiki

So you've built your map, done (or about to do) the config for it, but don't know how to actually submit it. It's easy! Make sure you read the Map Configuration Guide before reading this!

Getting started

First of you will need a Github account. To signup click the green "Sign up" box at the top right of the page and follow the instructions.

Forking the repo

To make your changes to the repo, you must first make a 'fork' of it. To do that, navigate to http://github.com/OresomeCraft/OresomeBattles-Maps and click the 'Fork' button on the top right.

After forking the repo you will be taken to your own copy of the repo. (Under your own account)

Adding your map

To add your map's config file, navigate to the 'classes' package. (src/com/oresomecraft/BattleMaps/classes)

To the right of the package path, there will be a small paper logo with a '+' on it. Click that to create the new file.

After doing that, you will be taken to an editor.

Copy and paste your config file into the editor. We recommend you write your config file with a text editor such as Notepad++, however you can just edit it on the online editor (not recommended). Remember to rename your file to YourMapName.java!

Important:

We have a code quality that must be kept with map submissions!

• Use spaces for indents! Strictly no TAB's!
• File's must be named like so; Say your map is called 'Battle of Oresome', the file would be called 'Battleoforesome.java'. (DO NOT forget to add the .java extension!)

Commit your changes!

To push the changes to your fork of the repo, scroll down to where it has the commit box, fill it in and click "Commit new file".

Submitting the pull request

A pull request means that you want to merge changes from your repo into the central repo. To open a pull request with your changes click on the 'Pull Request' button in the top right corner. If you don't create a pull request, and just leave your new map configuration under your own account, it won't be added, as we won't see it.

Once clicked, it should bring you to a screen like so:

Once filled in and a download link to the map has been supplied, click "Submit pull request".

Now, you wait

Once submitted a pull request and issue will be opened on our main repo. We will look over the config file and comment on anything that needs to be changed or can be improved. Make sure you actively check your Github notifications to keep up to date on the discussion. (The little dot next to the Github logo)

If you would like to talk to a developer (mainly Zachoz), or a member of the MapDev team, just jump on IRC and we'll be more than happy to help!

Don't know how to get to IRC? See http://oresomecraft.com/pages/chat/