Development for Stratagus

Bugs

Building Stratagus

Getting Stratagus from Launchpad Bazaar branches

How do I get the latest source code of Stratagus?

For example:

bzr branch lp:stratagus

This is done only once. To update your working copy, go into the directory and type 'bzr pull'.

Getting Stratagus without Bazaar

Compiling Stratagus

Source code documentation

You need either DoxyGen or DOC++ to generate source code documentation. You may then use the following commands to produce the documentation:

• If you use DoxyGen: make doc
• If you use DOC++: make doc++

Tags used in source code

Multi line source code documentation:

/** ... */

Single line source code documentation:

/// ...

Start grouping:

//@{ or /*@{*/

End grouping:

//@} or /*@}*/

• @name
  Name of file or group.
• @param
  Describes function/macro parameter
• @return
  Describes function return
• @see
  Links to other section

Please read the doxygen/doc++ documentation.

Empty C prototype file

//       _________ __                 __                               
//      /   _____//  |_____________ _/  |______     ____  __ __  ______
//      \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
//      /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \ 
//     /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
//             \/                  \/          \//_____/            \/ 
//  ______________________                           ______________________
//                        T H E   W A R   B E G I N S
//  Stratagus - A free fantasy real time strategy game engine
//
/**@name {filename}.c	-	{One line description of this file} */
//
//  (c) Copyright 2006 by {insert your name here}
//
//  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.
//
//  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.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 51 Franklin St, Fifth Floor, 
//  Boston, MA  02110-1301  USA
//
//  $Id$

//@{

#include <stdio.h>

#include "stratagus.h"
// More game includes.

// Global and local variables of this module.

// Local and global functions of this module.

//@}

Coding style

We suggest the Linux kernel coding style (also found online here).

• Write ANSI C++.
• All Tabs (Developers use 4 columns for a tab).
• No line should be longer than 78 characters.
• All comments should be on their own line.
• Use { } even for one statement blocks.

    // Example for statement with i incremented
    for (i = 0; i < sample->Length >> 1; ++i) {
        ...
    }

    // if statement with brackets and functions.
    if ((i = CLread(f, &chunk, sizeof(chunk))) != sizeof(chunk)) {
        ...
    }

    // function with variables defined.
    int function(int a, int b)
    {
        int x;
        int y;

        x = a;
        y = b;

        return 0;
    }
	
    // Example of a function
    static int CclLoadPud(lua_State* l)
    {
        const char* name;

        if (SaveGameLoading) {
            return 0;
        }

        if (lua_gettop(l) != 1) {
            LuaError(l, "incorrect argument");
        }
        name = LuaToString(l, 1);
        LoadPud(name, &TheMap);

        // FIXME: LoadPud should return an error
        return 0;
    }

Sending a patch