Getting Started

Here you'll find basic startup tutorials and guides.

Contents

• Contributing
  • New game system
  • Existing game system
• Tutorials
• Guidelines and conventions
• Additional Links

Contributing

PLEASE READ: 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.

To help us develop and maintain datafiles:

New game system

See the details at https://github.com/BSData/catalogue-development/wiki/Help:-Hosting-repositories for how to host your repo within Github and subsequently add it to the Gallery system.

Existing game system

0. Prerequisites:

   • GitHub account (personal and free) - register at https://github.com/join
   • Required lectures:
     • all Guidelines and conventions
     • Data Author Guide (and optionally our nice Video Tutorial)

1. Prepare your workbench by installing newest versions of:

   • BattleScribe: http://www.battlescribe.net/
   • GitHub desktop app:
     • Windows: http://windows.github.com
     • Mac: http://mac.github.com

2. Log in to GitHub desktop app. You probably won't have any repositories listed - that's ok :)

3. The next steps depend on the repository:

   • The more active ones, like: wh40k, Horus Heresy, etc. often have a core team of maintainers that have write access (can actually modify the repo):

     • they author data files, often splitting responsibility for different files between them
     • they often work continuously so it's very important that you ask before making changes; it's possible they have local changes. If you open a PR and the file codeowner also has changes, he'll probably prioritize his own and your changes will be lost.
     • after you contact codeowner (through an issue or via discord), you can start working: you should fork the repository, make changes and submit them as Pull Request - this flow is described in detail at GitHub Forking Guide.

   • For all the other repositories you should ask for write access and make changes directly. To do that, open a new issue in the appropriate repo - Join repository. Once you do that:

     • We'll invite you as a collaborator
     • You'll get an email with the invitation
     • Accepting the invitation will give you write access to the repository

Tutorials

• Video Tutorial
• Forking Guide
• Data Author Guide
• Data Admin Guide

Guidelines and conventions

• Code of Conduct
• Catalogue Guidelines

Additional Links

• BattleScribe homepage
• BattleScribe Data on AppSpot