= Development =

[[TracNav(TracNav/TOC_Development)]]

{{{
#!div style="background-color: #FFFFDD; border: 3px solid #000000; margin: 5px; padding: 10px; width: 710px;"
[[span('''General Information''', style=font-family: sans-serif; font-size: 16px)]]
 * [http://www.orxonox.net/ Orxonox] is a cross platform open source 3D game, programmed in C++
 * Orxonox is developed by students at the [http://www.ethz.ch ETH Zürich]
 * '''PPS students go [wiki:PPS_main here]'''
 * You can contact us in the [http://forum.orxonox.net/ forum] or in [irc://irc.orxonox.net/orxonox IRC] ([http://irc.orxonox.net?join=orxonox webclient])
 * Mailing lists: [https://admin.orxonox.net/mailman/listinfo/orxonox-announce announce] (for everyone), [https://admin.orxonox.net/mailman/listinfo/orxonox-dev dev] (for developers), [https://admin.orxonox.net/mailman/listinfo/tickets ticket] (Ticket changes) and [https://admin.orxonox.net/mailman/listinfo/orxonox-commit commit] (for coders)
 * The [wiki:credits team] behind Orxonox
}}}

{{{
#!div style="background-color: #F4F4FF; border: 3px solid #000000; margin: 5px; padding: 10px; width: 710px;"
[[span('''Development''', style=font-family: sans-serif; font-size: 16px)]]
 * We use [wiki:SVN] for revision control (code and media)
  * Main code repository: http://svn.orxonox.net/game/code/trunk/
  * Main data repository: http://svn.orxonox.net/game/data/trunk/
 * [wiki:download Instructions] on how to build the game from source.
 * If you want to help us, feel free to contact us. Read [wiki:Contribute this] for a short introduction
 * Found a bug? Tell us in the [http://forum.orxonox.net/viewforum.php?f=6 forum] or create a [http://www.orxonox.net/newticket ticket]
 * Read more about the ticket system and the Roadmap [wiki:TicketsystemHowTo here].
 * Read [wiki:WikiFormatting this] to learn about wiki formatting
 * Read the sections below about programming and content creation for detailed information
}}}

{{{
#!div width="50%" style="background-color: #F7F7F7; border: 1px solid #888888; margin: 5px; padding: 10px; width: 46%; float: left;"
[[span('''Programming''', style=font-family: sans-serif; font-size: 16px)]]

Here you find all information about how to write code for Orxonox.

{{{
#!html
<hr style="margin:0px;">
}}}
'''Installation''':
 * Follow the instructions at the [wiki:download] page

{{{
#!html
<hr style="margin:0px;">
}}}
'''Documentation''':
 * [wiki:ModulesDescription Modules] - Get an overview of our Framework
 * [wiki:Documentation] - A documentation of all our libraries and classes
 * [wiki:Libraries] - An overview of the external libraries
 * [doxygen:index.html API Reference] - An automatically generated reference of classes, functions, macros and other stuff
 * [wiki:HowTo_coding HowTo] - This page covers several topics and explains how to do things
 * [wiki:FAQ_coding FAQ] - Check out the FAQ to get answers on frequent questions

{{{
#!html
<hr style="margin:0px;">
}}}
'''Coding''':
 * [wiki:c++_styleguide Styleguide] - Please read and follow the Styleguide to create readable and useful code
 * [wiki:Doxygen Commenting] your source code in a professional way is very important.
 * [wiki:howto/STL Standard C++ library] - Have a look at the standard C++ library, strings and STL containers are very useful
 * [wiki:PerformanceTips Performance] - Learn how to write fast code

{{{
#!html
<hr style="margin:0px;">
}}}
'''Tools''':
 * [wiki:SVN] - Our revision control tool. You should know how to use it
 * [wiki:CMake] - Our build tool (forget about makefiles)
 * [wiki:KDevelop3] - An open source IDE
 * [wiki:Debugging] - Some information about various debuggers
 * [wiki:LinuxCodingTools Other Tools] - A list of other development tools

}}}
{{{
#!div style="background-color: #F7F7F7; border: 1px solid #888888; margin: 5px; padding: 10px; width: 46%; float: right;"
[[span('''Content Creation''', style=font-family: sans-serif; font-size: 16px)]]

This section is about model creation, design, sound and everything that is somehow related to the game content.

 * [wiki:ContentState Overview] - Read about the current state of content creation. If you want a brief overview, this is the place to start.

 * [wiki:Universe] - All about the Orxonox universe. Learn about the planets, factions, people and the technology in the game.

 * [wiki:cc_guidelines Guidelines] - The guidelines in place to promote a consistent style through out the game.

 * [wiki:Gallery Gallery] - Here, you can see what our content creation team has achieved so far. Take a look at futuristic spaceships and fancy aliens.

 * [wiki:Story] - Read what happens in the game. Spoiler Alert!

 * [wiki:ContentCreationTuts Tutorials] - Do you want to learn about the software we use for modelling and level design? Or would you like to create your own 3d-model? Go on and try some of our tutorials, it's easy to learn!

 * [wiki:content Alphabetical List of Content-Related Pages] - If you are looking for something specific, you will find it in this index.

 * [https://forum.orxonox.net/viewforum.php?f=8 Content Creation Board] - Visit the board about content creation on our forums.
}}}

{{{
#!div style="background-color: #FFFFFF; border: 1px dotted #888888; margin: 5px; padding: 10px; clear: both;"
[[span('''Miscellaneous''', style=font-family: sans-serif; font-size: 16px)]]
 * Useful [wiki:DevelopmentResources Links]
 * An incomplete wiki overview: [wiki:archive], [wiki:code], [wiki:content], [wiki:howtos], [wiki:persons], [wiki:PPS], [wiki:websites]
}}}