Debian Codegraph @

doc/development.html

raw
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <!--
5
6 ---- (c) Copyright 2001-2023 by Lutz Sammer, Francois Beerten and Nehal Mistry
7
8 ---- This program is free software; you can redistribute it and/or modify
9 ---- it under the terms of the GNU General Public License as published by
10 ---- the Free Software Foundation; only version 2 of the License.
11 ----
12 ---- This program is distributed in the hope that it will be useful,
13 ---- but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ---- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ---- GNU General Public License for more details.
16 ----
17 ---- You should have received a copy of the GNU General Public License
18 ---- along with this program; if not, write to the Free Software
19 ---- Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20 ---- 02111-1307, USA.
21 -->
22 <title>Development for Bos Wars</title>
23 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
24 </head>
25
26 <body>
27
28 <h1>Development for Bos Wars</h1>
29 <hr>
30
31 This file should give you some information to help with development of
32 the project.<p>
33
34 For most up to date information, it is highly recommended to check the
35 information on the Bos Wars <a href="https://boswars.org">website</a>,
36 including the page on <a href="https://boswars.org/development.shtml">development</a>.<p>
37
38
39 <h2>IRC - Internet Relay Chat</h2>
40
41 You can try to meet other Bos Wars developers and users on the
42 <a href="https://libera.chat/">Libera.chat</a> IRC Network, in the
43 <a href="irc://irc.libera.chat/boswars">#boswars</a> channel.
44
45 <h2>Mailing list</h2>
46
47 If you want to help with development, you should
48 <a href="http://archives.seul.org/bos/dev/">join</a>
49 the bos-dev mailing list.
50
51 <h2>Bugs and tasks</h2>
52
53 You can find <a
54 href="http://savannah.nongnu.org/bugs/?group=stratagus-bos">known bugs</a>
55 on the <a
56 href="http://boswars.org">project pages
57 for Bos Wars</a>.<p>
58
59 Before starting work on a bug or task, please ask on the mailing list or in the
60 IRC channel whether anybody else is already working on it.
61
62 <h2>Building Bos Wars</h2>
63
64 <h3>Installing the Git client</h3>
65
66 If you want to help develop, you should use Git.
67 The online <a href="https://git-scm.com/doc">Git documentation</a> will
68 help you master Git.
69
70 <h3>Getting Bos Wars from Git</h3>
71
72 The <a href="https://codeberg.org/boswars">Bos Wars project</a> has the following main repositories:
73
74 <ul>
75 <li>boswars - The Bos Wars source code<p>
76 The source code for the whole game including the engine.
77 The source is licenced under the GNU General Public License.
78 <b>This contains the sources needed for development.</b>
79
80 <li>website.bos - The Bos Wars Website<p>
81 The website is stored in git for easy updating and version management
82 by multiple people. This module is not needed unless you plan to update
83 the website.
84
85 <li>materials.bos - Bos Wars assets<p>
86 Sources of large or difficult to generate Boswars assets like graphics
87 and sounds.
88
89 </ul>
90
91
92 <h3>Getting Bos Wars without Git</h3>
93
94 Only releases are made outside of Git. If you wish to be involved with
95 development, you should obtain the sources via Git.
96 Git usually remains quite stable and is easier
97 for you to keep up to date. Release versions of Bos Wars are available
98 <a href="http://www.boswars.org/download.shtml">here</a>.
99
100 <h3>Building Bos Wars</h3>
101
102 You can find instructions for compiling Bos Wars at
103 <a href="install.html">install.html</a>.<br>
104 Since you already have a copy of the source, you may skip
105 ahead to step 2.
106
107 <h2>Source code documentation</h2>
108
109 The engine has tagged source documentation.<p>
110
111 You need either <a href="http://www.doxygen.org">DoxyGen</a> or
112 <a href="http://docpp.sourceforge.net/">DOC++</a>
113 to generate source code documentation.
114
115 <h3>Tags used in source code</h3>
116
117 We use the doc++ tags:<p>
118
119 Multi line source code documentation:<p>
120 /** ... */<p>
121
122 Single line source code documentation:<p>
123 /// ... <p>
124
125 Start grouping:<p>
126 //@{ or /*@{*/<p>
127
128 End grouping:<p>
129 //@} or /*@}*/<p>
130
131
132 <ul>
133 <li>@name
134 <br>Name of file or group.
135 <li>@param
136 <br>Describes function/macro parameter
137 <li>@return
138 <br>Describes function return
139 <li>@see
140 <br>Links to other section
141 </ul><p>
142
143 Please read the doxygen/doc++ documentation.
144
145 <h2>Sending a patch</h2>
146
147 Once you have completed some work, you will probably want it to be
148 included in the main Bos Wars source.<p>
149
150 You can create a pull request on the
151 <a href="https://codeberg.org/boswars/boswars">Bos Wars Codeberg project page</a>.
152 <p>
153
154 Alternatively, you can create a patch with these steps:<p>
155 <ul>
156 <li>git diff &gt; your-nickname.diff
157 <li>upload 'your-nickname.diff' to the
158 <a href="http://savannah.nongnu.org/patch/?group=stratagus-bos">patch tracker</a>.
159 </ul>
160
161 <hr>
162 (C) Copyright 1998-2023 by The <a href="http://www.boswars.org">Bos Wars</a> Project
163 under the <a href="gpl.html">GNU General Public License</a>.<br>
164 All trademarks and copyrights on this page are owned by their respective owners.<br>
165 </body>
166 </html>