summaryrefslogtreecommitdiffstats
path: root/doc/index.rst
blob: c4184d58815fc0457f6fdf148c5498660cee401b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
WEATBAG contributor information
===============================

You don't just play WEATBAG, you can take part in creating it too. These docs
explain how to write new tiles for the game.

The idea is that anything goes, but we do need a few house rules:

1. Don't mess with the real life user or their computer. Deleting files,
   accessing personal information, sending spam and executing untrusted code are
   all off limits.

2. The content is in English. If you want to work in another language, you're
   welcome to take our code and start your own fork.

3. For now, stick to what's provided in the Python 3 standard library. We might
   allow some extra dependencies later on.

.. toctree::
   :maxdepth: 2
   
   interface.rst
   api_misc.rst
   testing.rst

If you prefer to learn by example, have a look at the `tiles already in the game
<https://github.com/takluyver/weatbag/tree/master/weatbag/tiles>`_.

Once you've made a tile or a group of tiles, submit a pull request to add it to
the game. Don't hang about - if someone else adds tiles in the same location,
the first one ready to merge gets the spot.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`