Home

Here you'll find tutorials and guides. And some technical documentation (in future).

Project Overview

####Content:####

• Getting started
• Tutorials
• Guidelines and conventions
  • For Developers
  • For Admins
• Links

##Getting started##

Note: these steps are for people who want to help us create better data files. If you just want to use them, please visit BattleScribe Data on AppSpot.

Decide if you want to develop with us, or as a freelancer. To be a member or not to be

To join us:

1. If you don't already have, download and install newest BattleScribe version: http://www.battlescribe.net/downloads.html
2. Download and install GitHub app for desktop
   • Windows: http://windows.github.com
   • Mac: http://mac.github.com
3. Sign up for (personal and free) GitHub account:
   • either run app, click "log in" and then "Sign up" on the bottom
   • or click https://github.com/join
4. Log in to desktop app. Now you probably won't have any repositories listed. That's ok :)
5. Now you need to ask us to be added as admin/dev.

• we suggest you leave a comment in a new issue in appropriate repo BUT PLEASE READ: There's no need for you to join, if you just want to use the datafiles. For datafiles, just visit AppSpot page. Now, if you're still reading, choose where do you want to contribute:
  • Organisation (help develop webpage, backend app etc):
    • BSData
  • Games Workshop systems:
    • Battlefleet Gothic
    • Blood Bowl
    • Hobbit SBG
    • Mordheim
    • Necromunda
    • Warhammer 40k
    • Warhammer 40k: Epic Armageddon
    • Warhammer 40k: Heralds of Ruin Killteam
    • Warhammer 40k: Horus Heresy
    • Warhammer: Age of Sigmar
    • Warhammer Diskwars by FFG
    • Warhammer Fantasy Battle
  • Other systems:
    • Battletech Quick Strike
    • Bolt Action
    • D&D Attack Wing
    • Deadzone
    • Dust Tactics
    • Dystopian Legions
    • Dystopian Wars
    • Firestorm Armada
    • Flames of War
    • Judge Dredd
    • Kings of War
    • Malifaux
    • Mars Attacks
    • Robotech RPG Tactics
    • Star Wars: Armada
    • Star Wars: X-Wing
    • Warmachine & Hordes
    • Warpath
    • Wild West Exodus
• Can't wait? Fork repo! Forking Guide
• When we invite you, you'll get an email - accept the invitation and be welcome!

6. In the meantime (until we invite you to admin/dev team) take a look at:

• Developer Guide (and our nice Video Tutorial)
• (and Admin Guide if appropriate)
• And first and foremost into Membership Guidelines

##Tutorials##

• Video Tutorial
• Forking Guide
• Developer Guide
• Admin Guide

##Guidelines and conventions##

####For developers####

• Membership Guidelines
• Developer Guide
• Catalogue Naming Convention
• Simple: Issues
• General Catalogue writing guidelines
• Tips & Tricks

####For admins####

additionally:

• Admin Guide
• Managing files and repos (dead link)
• Simple: pull requests and branches (dead link)
• Admin Tips & Tricks (dead link)

##Links##

• Project Overview
• BattleScribe homepage
• BattleScribe Data on AppSpot