Map Makers: Getting Started and Workflow

Welcome!

Managing files in GitHub can be done directly in your web browser:

• http://github.com/blog/2105-upload-files-to-your-repositories
• http://help.github.com/articles/editing-files-in-your-repository

For most people, that perhaps will be sufficient. If you wish, you can also use "Git For Windows", a local Git client you can install that will help you work with map files locally. A folder is 'connected' to git when it contains another ".git" folder. Then the client application helps you pull down changes from the remote repository, it lets you then stage and commit files - which effectively are restore check points. Finally it lets you push those changes.

Instructions for Git For Windows

Again, Github allows you to use your web browser only. If you're going to be doing more extensive work, a Git client could be of benefit. If you want to get set up with Git for windows, here are the steps:

• Download it: Git for windows

• Follow step number 2 at: http://code.tutsplus.com/tutorials/git-on-windows-for-newbs--net-25847, this will save you from having to type your Github password all the time

• Setup your local Git email and username

• For some more background, this is a pretty good tutorial on Git for windows: http://code.tutsplus.com/tutorials/git-on-windows-for-newbs--net-25847

Super high level overview of the Work flow using Git For Windows

• Clone: This downloads a copy of the github repository to a new folder on your file system

• Modify files: When the files are on your system, they'll land in a new folder. You can then edit and add to them as normal.

• Commit: launching Git on that folder (right click the folder and you'll have a menu option for "Git GUI form here"), and you can scan for changes, and commit them. This is flagging files that you want to have uploaded, and adding a change message that will be recorded in the change history

• Push: This is git terminology for uploading your committed changes.

WorkFlow

Please follow the links below to learn how to do each task.

1. Update the XML configuration of an existing map
2. [Update files of an existing map](Map-Makers%3A-Update files of an existing map) (also how to upload new files)
3. [Create a new map](Map-Makers%3A-Create a new map)
4. [Download your map Zip](Map-Makers%3A-Download your map zip)
5. [Request that a new map version go live](Map-Makers%3A-Request that a new map version go live) for in-game downloads

Key Concepts

Remote repository

A key concept in Git is that you are linking files on your local file system, with files stored in the cloud somewhere, a "remote repostory". This file link is essentially ensuring that your local file system copy matches what is off in the cloud.

The files in the cloud are the ones the game will be working with, by mirroring these files, you can modify and add new ones, and then instruct git to update the cloud version. You can also use Git to update your local files, to resync with what is in the cloud.