2003-05-03 08:09:58 -06:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
2000-03-25 15:38:54 -07:00
|
|
|
<!--
|
2011-03-26 16:40:53 -06:00
|
|
|
---- (c) Copyright 2001-2011 by Lutz Sammer, Francois Beerten,
|
|
|
|
|
---- Nehal Mistry and Pali Rohár
|
2001-05-30 08:20:03 -06:00
|
|
|
|
2003-07-03 10:08:07 -06:00
|
|
|
---- This program is free software; you can redistribute it and/or modify
|
2001-05-30 08:20:03 -06:00
|
|
|
---- it under the terms of the GNU General Public License as published by
|
2004-03-29 16:51:25 -07:00
|
|
|
---- the Free Software Foundation; only version 2 of the License.
|
2003-07-03 10:08:07 -06:00
|
|
|
----
|
|
|
|
|
---- This program is distributed in the hope that it will be useful,
|
2001-05-30 08:20:03 -06:00
|
|
|
---- but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
---- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
---- GNU General Public License for more details.
|
2003-07-03 10:08:07 -06:00
|
|
|
----
|
|
|
|
|
---- You should have received a copy of the GNU General Public License
|
|
|
|
|
---- along with this program; if not, write to the Free Software
|
2017-02-17 04:47:15 -07:00
|
|
|
---- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
|
|
|
---- 02110-1301, USA.
|
2000-03-25 15:38:54 -07:00
|
|
|
-->
|
2007-02-28 22:29:54 -07:00
|
|
|
<title>Development for Stratagus</title>
|
2003-05-03 08:09:58 -06:00
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
2003-04-22 18:44:03 -06:00
|
|
|
</head>
|
2003-05-03 08:09:58 -06:00
|
|
|
|
2003-04-22 18:44:03 -06:00
|
|
|
<body>
|
2003-05-03 08:09:58 -06:00
|
|
|
|
2011-03-26 18:10:43 -06:00
|
|
|
<pre width=80>
|
2012-07-24 05:54:25 -06:00
|
|
|
_________ __ __
|
2011-03-26 18:10:43 -06:00
|
|
|
/ _____// |_____________ _/ |______ ____ __ __ ______
|
|
|
|
|
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
|
2012-07-24 05:54:25 -06:00
|
|
|
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
|
2011-03-26 18:10:43 -06:00
|
|
|
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
|
2012-07-24 05:54:25 -06:00
|
|
|
\/ \/ \//_____/ \/
|
2011-03-26 18:10:43 -06:00
|
|
|
______________________ ______________________
|
2012-07-24 05:54:25 -06:00
|
|
|
T H E W A R B E G I N S
|
|
|
|
|
Stratagus - A free fantasy real time strategy game engine
|
2011-03-26 18:10:43 -06:00
|
|
|
</pre>
|
|
|
|
|
<hr>
|
|
|
|
|
|
2007-02-28 22:29:54 -07:00
|
|
|
<h1>Development for Stratagus</h1>
|
2003-04-22 18:44:03 -06:00
|
|
|
<hr>
|
2000-03-25 15:38:54 -07:00
|
|
|
|
2003-07-03 09:35:45 -06:00
|
|
|
This file should give you some information to help with development of Stratagus.<p>
|
2001-05-30 08:20:03 -06:00
|
|
|
|
2010-08-02 09:52:16 -06:00
|
|
|
<h2>Bugs</h2>
|
2001-05-30 08:20:03 -06:00
|
|
|
|
2003-09-03 04:46:49 -06:00
|
|
|
You can find <a
|
2010-08-02 09:52:16 -06:00
|
|
|
href="https://bugs.launchpad.net/stratagus">known bugs</a>
|
2013-03-09 05:19:48 -07:00
|
|
|
on the <a href="https://launchpad.net/stratagus">Launchpad pages for Stratagus</a>.<p>
|
2001-05-30 08:20:03 -06:00
|
|
|
|
2003-07-03 09:35:45 -06:00
|
|
|
<h2>Building Stratagus</h2>
|
2001-06-18 08:20:24 -06:00
|
|
|
|
2015-12-08 02:55:16 -07:00
|
|
|
<h3>Getting Stratagus from Github</h3>
|
2001-06-18 08:20:24 -06:00
|
|
|
|
2006-04-23 06:35:31 -06:00
|
|
|
<h4>How do I get the latest source code of Stratagus?</h4>
|
|
|
|
|
|
2015-12-08 02:55:16 -07:00
|
|
|
The source code is hosted on <a href="https://github.com/Wargus/stratagus">Github</a>.
|
2006-04-23 06:35:31 -06:00
|
|
|
<p>
|
2001-06-18 08:20:24 -06:00
|
|
|
|
2015-12-08 02:55:16 -07:00
|
|
|
To clone master:<p>
|
2001-06-18 08:20:24 -06:00
|
|
|
|
2015-12-08 02:55:16 -07:00
|
|
|
<pre>git clone https://github.com/Wargus/stratagus</pre>
|
2006-04-23 06:35:31 -06:00
|
|
|
<p>
|
2001-06-18 08:20:24 -06:00
|
|
|
|
2012-07-24 05:54:25 -06:00
|
|
|
This is done only once. To update your working copy, go into
|
2015-12-08 02:55:16 -07:00
|
|
|
the directory and type 'git pull'.<p>
|
2001-07-25 15:58:52 -06:00
|
|
|
|
2015-12-08 02:55:16 -07:00
|
|
|
<h3>Getting Stratagus source without Git</h3>
|
|
|
|
|
|
|
|
|
|
Just go to the <a href="https://github.com/Wargus/stratagus">Github</a> page and click on
|
|
|
|
|
<a href="https://github.com/Wargus/stratagus/archive/master.zip">"Download ZIP"</a>.
|
2002-06-26 16:07:28 -06:00
|
|
|
|
2003-07-03 09:35:45 -06:00
|
|
|
<h3>Compiling Stratagus</h3>
|
2003-04-22 18:44:03 -06:00
|
|
|
|
2012-07-24 05:54:25 -06:00
|
|
|
You can find instructions for compiling Stratagus at
|
2003-05-03 08:09:58 -06:00
|
|
|
<a href="install.html">install.html</a>.<br>
|
2012-07-24 05:54:25 -06:00
|
|
|
Since you already have a copy of the source, you may skip
|
2011-08-09 01:13:40 -06:00
|
|
|
ahead to Installation Step 2.
|
2001-03-10 16:25:40 -07:00
|
|
|
|
2003-04-22 18:44:03 -06:00
|
|
|
<h2>Source code documentation</h2>
|
2000-03-25 15:38:54 -07:00
|
|
|
|
2012-07-24 05:54:25 -06:00
|
|
|
Valery Shchedrin has introduced tagged source
|
2003-07-03 09:35:45 -06:00
|
|
|
documentation for Stratagus.<p>
|
2000-03-25 15:38:54 -07:00
|
|
|
|
2012-07-24 05:54:25 -06:00
|
|
|
You need
|
2011-03-26 16:40:53 -06:00
|
|
|
<a href="http://www.doxygen.org">DoxyGen</a>
|
2011-08-09 01:13:40 -06:00
|
|
|
to generate source code documentation.<p>
|
|
|
|
|
|
2012-07-24 05:54:25 -06:00
|
|
|
Having DoxyGen installed, compile Stratagus with option ENABLE_DOC=ON<br>
|
2011-08-09 01:13:40 -06:00
|
|
|
(e.g, inside build directory, run 'cmake -DENABLE_DOC=ON .. && make').<p>
|
|
|
|
|
|
|
|
|
|
Source documents are initially generated inside the build directory, as done for binaries.<p>
|
|
|
|
|
|
|
|
|
|
After installing stratagus (using 'make install') you can find all these html files in<br>
|
|
|
|
|
<u>share/doc/stratagus</u> directory.<p>
|
|
|
|
|
|
|
|
|
|
When installing Stratagus html these files are copied into <u>PREFIX/share/stratagus/doc</u>.<br>
|
|
|
|
|
Doxygen documentation is copied into <u>PREFIX/share/stratagus/doc/doxygen</u>.<p>
|
|
|
|
|
|
|
|
|
|
If you are viewing installed stratagus documentation, Doxygen documentation is here: <a href="doxygen/index.html">doxygen/index.html</a>
|
2003-04-22 18:44:03 -06:00
|
|
|
|
|
|
|
|
<h3>Tags used in source code</h3>
|
|
|
|
|
|
2003-05-03 08:09:58 -06:00
|
|
|
We use the doc++ tags:<p>
|
2013-03-09 05:19:48 -07:00
|
|
|
Multi line source code documentation: /** ... */<br/>
|
|
|
|
|
Single line source code documentation: /// ... <br/>
|
|
|
|
|
Start grouping: //@{ or /*@{*/<br/>
|
|
|
|
|
End grouping: //@} or /*@}*/<br/>
|
2003-04-22 18:44:03 -06:00
|
|
|
|
|
|
|
|
<ul>
|
2013-03-09 05:19:48 -07:00
|
|
|
<li>@name Name of file or group.</li>
|
|
|
|
|
<li>@param Describes function/macro parameter</li>
|
|
|
|
|
<li>@return Describes function return</li>
|
|
|
|
|
<li>@see Links to other section</li>
|
2003-05-03 08:09:58 -06:00
|
|
|
</ul><p>
|
|
|
|
|
|
|
|
|
|
Please read the doxygen/doc++ documentation.
|
2000-03-25 15:38:54 -07:00
|
|
|
|
2011-03-26 18:10:43 -06:00
|
|
|
<h2>Empty C++ prototype file</h2>
|
2001-03-10 16:25:40 -07:00
|
|
|
|
2003-04-22 18:44:03 -06:00
|
|
|
<pre>
|
2012-07-24 05:54:25 -06:00
|
|
|
// _________ __ __
|
2003-07-03 09:55:38 -06:00
|
|
|
// / _____// |_____________ _/ |______ ____ __ __ ______
|
|
|
|
|
// \_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
|
2012-07-24 05:54:25 -06:00
|
|
|
// / \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
|
2003-07-03 09:55:38 -06:00
|
|
|
// /_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
|
2012-07-24 05:54:25 -06:00
|
|
|
// \/ \/ \//_____/ \/
|
2001-03-10 16:25:40 -07:00
|
|
|
// ______________________ ______________________
|
2004-06-05 23:22:25 -06:00
|
|
|
// T H E W A R B E G I N S
|
|
|
|
|
// Stratagus - A free fantasy real time strategy game engine
|
2001-03-10 16:25:40 -07:00
|
|
|
//
|
2011-03-26 16:40:53 -06:00
|
|
|
/**@name {filename}.cpp - {One line description of this file} */
|
2001-03-10 16:25:40 -07:00
|
|
|
//
|
2011-03-26 16:40:53 -06:00
|
|
|
// (c) Copyright {year} by {insert your name here}
|
2001-03-10 16:25:40 -07:00
|
|
|
//
|
2004-06-05 23:22:25 -06:00
|
|
|
// This program is free software; you can redistribute it and/or modify
|
|
|
|
|
// it under the terms of the GNU General Public License as published by
|
|
|
|
|
// the Free Software Foundation; only version 2 of the License.
|
2001-05-30 08:20:03 -06:00
|
|
|
//
|
2004-06-05 23:22:25 -06:00
|
|
|
// This program is distributed in the hope that it will be useful,
|
|
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
// GNU General Public License for more details.
|
2003-07-03 09:59:56 -06:00
|
|
|
//
|
2004-06-05 23:22:25 -06:00
|
|
|
// You should have received a copy of the GNU General Public License
|
|
|
|
|
// along with this program; if not, write to the Free Software
|
2012-07-24 05:54:25 -06:00
|
|
|
// Foundation, Inc., 51 Franklin St, Fifth Floor,
|
2006-04-23 06:35:31 -06:00
|
|
|
// Boston, MA 02110-1301 USA
|
2001-05-30 08:20:03 -06:00
|
|
|
//
|
2001-03-10 16:25:40 -07:00
|
|
|
|
|
|
|
|
//@{
|
|
|
|
|
|
2003-07-03 09:35:45 -06:00
|
|
|
#include "stratagus.h"
|
2013-03-09 05:19:48 -07:00
|
|
|
|
2001-03-10 16:25:40 -07:00
|
|
|
// More game includes.
|
|
|
|
|
|
|
|
|
|
// Global and local variables of this module.
|
|
|
|
|
|
|
|
|
|
// Local and global functions of this module.
|
|
|
|
|
|
|
|
|
|
//@}
|
2003-04-22 18:44:03 -06:00
|
|
|
</pre>
|
2001-03-10 16:25:40 -07:00
|
|
|
|
2003-04-22 18:44:03 -06:00
|
|
|
<h2>Coding style</h2>
|
2000-03-25 15:38:54 -07:00
|
|
|
|
2013-03-09 05:19:48 -07:00
|
|
|
We use <a href="http://astyle.sourceforge.net/">AStyle</a> to harmonize style in the code.<br/>
|
|
|
|
|
<code>AStyle --options=tools/astylerc --recursive "src/*.cpp" "src/*.h"</code>
|
2003-05-03 08:09:58 -06:00
|
|
|
|
2003-04-22 18:44:03 -06:00
|
|
|
<h2>Sending a patch</h2>
|
2001-06-18 08:20:24 -06:00
|
|
|
|
2011-03-26 16:40:53 -06:00
|
|
|
Use Stratagus launchpad <a href="https://bugs.launchpad.net/stratagus">bug tracker</a>
|
2013-03-09 05:19:48 -07:00
|
|
|
<br/>
|
|
|
|
|
NOTE: If you make big changes please always extend the copyright with your name,
|
|
|
|
|
and always update the copyright year if required.<p>
|
2011-03-26 16:40:53 -06:00
|
|
|
|
2015-12-08 02:55:16 -07:00
|
|
|
<hr> (C) Copyright 1998-2015 by The <a
|
|
|
|
|
href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a
|
|
|
|
|
href="gpl.html">GNU General Public License</a>.<br> All trademarks and
|
|
|
|
|
copyrights on this page are owned by their respective owners.<br> </body>
|
2003-05-19 12:32:54 -06:00
|
|
|
</html>
|
