Documentation

Take part fr en 

How to help

Rolisteam needs attention in many domains. It is always appreciated.

Contact us

You want to help but don’t how. The first step is to contact us. It is better to plan together what to do.

Source code

Interested in writing Rolisteam code. Rolisteam is written in C++(11) and it is based on Qt5 framework. its source code is managed on github. We use git.

Official Rolisteam Page

Depending on how deep you want to be in Rolisteam development, there is two main ways to contribute.

Alone programmer

This approach is great for people who want to implement one feature or fix few stuff. The workflow is simple:

  1. Get a github account
  2. Fork rolisteam and its submodules (common, diceparser, charactersheet, RPlugins), all projets appears on your github profile
  3. clone those git project on your computer.
  4. Write the modification
  5. Test the modification
  6. Make “pull request”

Be part of the project

  1. Get a github account
  2. Ask to be part of Rolisteam’s team
  3. When its granted you can clone official rolisteam repositories (and its subproject)
  4. Write your code and commit your change.

To show your motivation is a good start to contribute several times as programmer. Then ask to be part of the team.

Please take a look here to compile it on windows, on Linux, on MacOsX. The page should have all needed information.

Don’t hesitate to contact us to speak about your intensions. So we can support your effort.

To know what to do on Rolisteam, there is a development roadmap.

Ux design or graphics design

Please, contact us.

Translation

Rolisteam

We give information about translating rolisteam in the last section of this page

Documentation

Translated documentation is really helpful and it just requires few steps to work autonomously. First, learn how to write in markdown.

Secondly, it is important to use Git hub.

  1. Create a github account
  2. Fork the documentation.
  3. Modify the documentation inside your git repository. Github provides preview on markdown file.
  4. Make pull request to share your work.

In details, the second step will create a copy of the documentation into your own github account. So you have permission to do whatever you want on the documentation: fix it, improve it and so on. When the work is finished, you can create a pull request from your documentation copy to rolisteam’s documentation. Then, modifications are reviewed. If they look good. The pull request is accepted and your modification are now integrated inside the official documetation.

Translate the documentation in new language

Do the first three steps above and those following:

  1. Create new directory inside content\pages and name it with the 639-1 language code.
  2. Dupplicate all the page, pay attention to change the first four lines of each file.
  3. Translate files
  4. Make pull request to share your work

Generated the documentation

The documentation is generated in html thank of Pelican.

  1. Install it
  2. Get the documentation project:
    clone https://github.com/Rolisteam/Documentation.git Adapt the url to your github account if needed.
  3. Change project configuration to adapt it to your installation of Pelican.
  4. Install required plugin and theme to get the exact same aspect of online Rolisteam documentation.
  5. Generate html:

    make html

It is better to generate the documentation to see the final result. It may be difficult to set all the required tools. When doing a pull request, don’t forget to tell us that you did not test the generation.

Promotion

Talk about Rolisteam as often as possible.

Don’t hesitate to contact us to explain your initiative. We will be glad to talk about your videos, tutorials or games.

Précédent

Home