Skip to content

Latest commit

 

History

History
74 lines (45 loc) · 3.93 KB

README.md

File metadata and controls

74 lines (45 loc) · 3.93 KB
Raw

The Black Hack

This project publishes the "raw text" of the Roleplaying game "The Black Hack", by David Black. As specified in the License document, the text and tables are open game content.

It means that anyone can use this open game content and make derivative works without asking for permission, as long as this derivative fits the Open Gaming License terms.

GitHub tag Travis

The name "The Black Hack" is used here with kind permission of the author.

See the License for more details.

Contribute

Fix

Despite my keen eyes, I may have failed to correctly copy-paste the raw text and tables. Please ping me via this project issues or via Twitter or G+ if you spot any typo to be fixed.

Translate

The main purpose of this project is to allow translations of this open game content into other languages.

How-to

Let's say you want to translate "The Black Hack" into Klingon.

If you know how to use Github
  1. fork this project on github,
  2. on your local copy, create a klingon directory,
  3. in this directory, create a meta.yaml file. This file is plain text and should be exactly like the english/meta.yaml file, See the "meta" for more details.
  4. in this directory, create a the-black-hack.md file and start translating. This file should fit the Github Markdown syntax,
  5. Don't forget to add your name in the LICENSE file, in the last section "15 COPYRIGHT NOTICE" like this: "Klingon translation Copyright 2016, B'Elanna Torres".
  6. when you're done, submit a pull-request,
  7. there may be a few discussion about your translation (mostly about the Markdown syntax). When the pull-request is "ok", it'll be merged into the main repository.
If you don't know how Github is working

Contact me via e-mail or Twitter or G+ or any mean you can find and send me over a raw text translation of the game. I'll try to add it to the project ; and I may ask you to eventually help me to integrate it as best as possible.

Congratulations, you have contributed to this project

Make sure your contribution is okay

If you're geeky enough, you can try to use the command: make html to build HTML pages into the build/ directory. It only requires that (a recent version of) tox is available on your system.

Browse the build/ directory with your web browser to see your translation along with the others.

The Meta file

The meta file is a YAML, but it shouldn't be a problem. Your "klingon" meta file should look like this:

label: Klingon
author: B'Elanna Torres

Important

  • The meta file is completely optional, but it'll help improve the look'n'feel of the homepage.
  • the words label and author are case sensitive, so they'll have to be written exactly like this.
  • the author information is optional, although I'd recommend to provide it, in order to receive feedback (including praises from the community).

References