Difference between revisions of "Programming"

From FreeOrionWiki
Jump to: navigation, search
m (Reverted edit of Golgy, changed back to last version by Geoff the Medio)
(Replace intenal link to OpenGL with Wikipedia article.)
 
(24 intermediate revisions by 10 users not shown)
Line 1: Line 1:
[[FreeOrion]] is being made with C++, [[OpenGL]] and [[GiGi]].  The programming lead is [http://www.freeorion.org/forum/profile.php?mode=viewprofile&u=11 Tzlaine].
+
[[FreeOrion]] is being coded with C++, Boost, Python, [https://en.wikipedia.org/wiki/OpenGL OpenGL] and [[GiGi]].
  
If you want to contribute, please speak to [http://www.freeorion.org/forum/profile.php?mode=viewprofile&u=11 Tzlaine] and take the time to be familiar with the [[source code]].
+
If you want to contribute, please post on the forums (preferred) or send a forum private message to [http://freeorion.org/forum/memberlist.php?mode=viewprofile&u=142 Geoff the Medio].
  
For now if you would like to help, pick a feature request, email [http://www.freeorion.org/forum/profile.php?mode=viewprofile&u=11 Tzlaine], then work on it.
+
A list of programming tasks to be completed can be found on the [https://github.com/freeorion/freeorion/issues GitHub issues tracker].
  
[[Programming Work]] usually contains a list of things needed to be completed, which will be updated with the 0.4 list of tasks when ready.  For now, view the [http://sourceforge.net/tracker/?group_id=75752&atid=544942 bugs] and [http://sourceforge.net/tracker/?group_id=75752&atid=544945 feature requests].
+
For information on procedures, code standards, etc:
 
+
Here you can find information on procedures, code standards, etc:
+
* [[Change Control Guidelines]]
+
 
* [[Code Standards]]
 
* [[Code Standards]]
 
* [[Adding and removing source-files]]
 
* [[Adding and removing source-files]]
 +
 +
To submit code changes, create a pull request for the master branch on the [https://github.com/freeorion/freeorion FreeOrion github repository]. Be sure to note that you release your changes under the GPL 2.0 (or later) license.
 +
 +
You should expect your submissions to be reviewed and to receive feedback requesting changes before they are accepted and merged into master. Following the [[Code Standards]] for FreeOrion will likely reduce the number of changes needed.
 +
 +
==High-Level Structure of FreeOrion Code==
 +
 +
There are three FreeOrion modules: the human client, the server and the AI client. The server creates the game, and sends it out to the clients. Clients issue orders, which the server executes before updating the gamestate each turn and sending the new gamestate to the clients.
 +
 +
The gamestate comprises a Universe and a set of Empires. The Universe contains various UniverseObject subclasses: Buildings, Planets, Systems, Ships. Empire keeps track of individual empires: research and production status, homeworld, explored systems.
 +
 +
Various bits of game content are stored in manager classes, like TechManager. Techs, Buildings, Specials, etc. are defined in text files, which are parsed when the game starts up. The manager classes provide access to this info from anywhere that needs it.
 +
 +
Each screen in the UI has its own class, in which all the windows and widgets are objects. Most UI screens are objects contained within the MapWnd object. Generally UI classes communicate with classes they contain by calling public methods, and classes that contain them by emitting signals which the containing object has connected to various functions.

Latest revision as of 17:42, 25 March 2018

FreeOrion is being coded with C++, Boost, Python, OpenGL and GiGi.

If you want to contribute, please post on the forums (preferred) or send a forum private message to Geoff the Medio.

A list of programming tasks to be completed can be found on the GitHub issues tracker.

For information on procedures, code standards, etc:

To submit code changes, create a pull request for the master branch on the FreeOrion github repository. Be sure to note that you release your changes under the GPL 2.0 (or later) license.

You should expect your submissions to be reviewed and to receive feedback requesting changes before they are accepted and merged into master. Following the Code Standards for FreeOrion will likely reduce the number of changes needed.

High-Level Structure of FreeOrion Code

There are three FreeOrion modules: the human client, the server and the AI client. The server creates the game, and sends it out to the clients. Clients issue orders, which the server executes before updating the gamestate each turn and sending the new gamestate to the clients.

The gamestate comprises a Universe and a set of Empires. The Universe contains various UniverseObject subclasses: Buildings, Planets, Systems, Ships. Empire keeps track of individual empires: research and production status, homeworld, explored systems.

Various bits of game content are stored in manager classes, like TechManager. Techs, Buildings, Specials, etc. are defined in text files, which are parsed when the game starts up. The manager classes provide access to this info from anywhere that needs it.

Each screen in the UI has its own class, in which all the windows and widgets are objects. Most UI screens are objects contained within the MapWnd object. Generally UI classes communicate with classes they contain by calling public methods, and classes that contain them by emitting signals which the containing object has connected to various functions.