tCONTRIBUTING.md - vaccinewars - be a doctor and try to vaccinate the world
(HTM) git clone git://src.adamsgaard.dk/vaccinewars
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
tCONTRIBUTING.md (2733B)
---
1 # How to contribute
2
3 dopewars is open-source software, meaning that it is free for anybody to
4 use. However, this also means that the quality of the software is dependent
5 in part on **you** the user. You **don't** have to be a programmer to
6 help out - in fact, dopewars currently needs people to produce sounds and
7 graphics rather than to write code.
8
9 - **Sounds** are needed. dopewars-1.5.7 and later support sounds, but
10 don't contain sounds for every game event. If **you** can provide
11 copyright-free sounds, then short files are needed for various effects
12 in the game. For example, gunshots, bullet hits, ricochets and subway
13 trains are obvious candidates for sound effects, although pretty much
14 any event in the game that you can think of can conceivably have a sound
15 (e.g. when players join or leave the game). These sounds should be in WAV
16 format, and should probably be no more than a second or two in length.
17 Later versions of dopewars may also be able to play longer repeating
18 sounds (i.e. music) if you're interested in contributing this. Please
19 open a [pull request](https://github.com/benmwebb/dopewars/pulls)
20 to add sound files to dopewars.
21
22 - **Suggestions** for future improvements are always welcomed at the
23 [issue tracker](https://github.com/benmwebb/dopewars/issues).
24 These can be anything from "the game interface is confusing" through
25 "more game locations are needed" to "what about a hospital". (I can't
26 guarantee that such suggestions will ever make it into dopewars, but
27 it's a lot easier if I know they exist! Also, it's far more likely
28 to happen if you write the code - see the
29 [tips for developers](https://dopewars.sourceforge.io/docs/developer.html)
30 page.)
31
32 - **Bug reports** are always useful. Register them with the
33 [issue tracker](https://github.com/benmwebb/dopewars/issues).
34 If I don't know the problem exists, I can't fix it...
35 The more information you can give here, the better. In particular, I need
36 to know your operating system - e.g. Linux or Windows. For Linux, gdb stack
37 traces of the core file are most useful.
38
39 - **Configuration files** can be included in future distributions. If
40 you run a customised game, and think others might want to play with your
41 configuration, or at least use it as an example, then post it in the
42 [issue tracker](https://github.com/benmwebb/dopewars/issues).
43
44 - **Translation** of dopewars into your language will enable you to
45 play the game in your native tongue, and will also help others that speak
46 the same language. It's pretty easy, too - all you have to do is edit a
47 simple text file! See the
48 [i18n pages](https://dopewars.sourceforge.io/docs/developer.html).