= Development = {{{#!box tips = General Information = * [/ 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://lists.orxonox.net/mailman/listinfo/orxonox-announce announce] (for everyone), [https://lists.orxonox.net/mailman/listinfo/orxonox-dev dev] (for developers), [https://lists.orxonox.net/mailman/listinfo/tickets ticket] (Ticket changes) and [https://lists.orxonox.net/mailman/listinfo/orxonox-commit commit] (for coders) * The [wiki:dev/credits team] behind Orxonox }}} {{{#!box comment = Development = * We use [wiki:code/tools/SVN 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:dev/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 [wiki:WikiFormatting this] to learn about wiki formatting * Read the sections below about programming and content creation for detailed information }}} {{{#!rbox detail width="40%" = Content Creation = This section is about model creation, design, sound and everything that is somehow related to the game content. * [wiki:content/ContentState Overview] - Read about the current state of content creation. If you want a brief overview, this is the place to start. * [wiki:content/Universe Universe] - All about the Orxonox universe. Learn about the planets, factions, people and the technology in the game. * [wiki:content/CC_guidelines Guidelines] - The guidelines in place to promote a consistent style through out the game. * [wiki:content/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:content/Story Story] - Read what happens in the game. Spoiler Alert! * [wiki:content/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. }}} {{{#!box detail width="40%" = Programming = Here you find all information about how to write code for Orxonox. ---- '''Installation''': * Follow the instructions at the [wiki:download] page ---- '''Documentation''': * [wiki:code/doc/ModulesDescription Modules] - Get an overview of our Framework * [wiki:code/doc Documentation] - A documentation of all our libraries and classes * [wiki:code/libs Libraries] - An overview of the external libraries * [/jenkins/view/Management/job/orxonox_doxygen_trunk/javadoc/ API Reference] - An automatically generated reference of classes, functions, macros and other stuff * [wiki:code/howto HowTo] - This page covers several topics and explains how to do things * [wiki:code/FAQ FAQ] - Check out the FAQ to get answers on frequent questions ---- '''Coding''': * [wiki:code/C++_styleguide Styleguide] - Please read and follow the Styleguide to create readable and useful code * [wiki:code/tools/Doxygen Commenting] your source code in a professional way is very important. * [wiki:code/howto/STL Standard C++ library] - Have a look at the standard C++ library, strings and STL containers are very useful * [wiki:code/PerformanceTips Performance] - Learn how to write fast code ---- '''Tools''': * [wiki:code/tools/SVN SVN] - Our revision control tool. You should know how to use it * [wiki:code/tools/CMake CMake] - Our build tool (forget about makefiles) * [wiki:code/Buildsystem Buildsystem] - Build settings for CMake * [wiki:code/tools/KDevelop3 KDevelop3] - An open source IDE * [wiki:code/tools/EclipseIDE EclipseIDE] - Another fine IDE * [wiki:code/tools/Debugging Debugging] - Some information about various debuggers * [wiki:code/tools/LinuxCodingTools Other Tools] - A list of other development tools }}} {{{#!box = Miscellaneous = * Useful [wiki:dev/DevelopmentResources Links] * An incomplete wiki overview: [wiki:~archive], [wiki:code], [wiki:content], [wiki:code/howto], [wiki:people], [wiki:pps], [wiki:TitleIndex] [[CollapsibleStart(List of dev-pages)]] [[TitleIndex(dev/,format=hierarchy)]] [[CollapsibleEnd]] }}}