Development: Difference between revisions
Clonk-Karl (talk | contribs) Update for GSoC |
Rewrite. Put in the links from the "Developers Guide" page. Might actually be useful now. |
||
Line 1: | Line 1: | ||
OpenClonk is | OpenClonk is an open project. That means it depends on people coming in and helping out. People just like you! This page should give you an idea what you could do in order to get involved. | ||
== Use Nightlies == | |||
OpenClonk is continously in development. The "current" version can change daily! If you want to follow the development, it is a good idea to make sure you are able to run development versions. You will not need to build them yourself - just use the nightly builds linked below and you should be ready to go. | |||
* Nightly builds - [http://www.openclonk.org/nightly-builds/ www.openclonk.org/nightly-builds/] | |||
* Blog - [http://blog.openclonk.org blog.openclonk.org] | |||
* Changelog - [http://hg.openclonk.org/ hg.openclonk.org] | |||
* Browse source - [http://hg.openclonk.org/file/ hg.openclonk.org/file/] | |||
== Report Bugs == | |||
We cannot possibly account for every possible configuration out there. If you see something that's wrong, we would really like to know about it. Especially if you are willing to actively work with us in finding a solution for the problem. | |||
Here's how you can reach us: | |||
* IRC - [irc://irc.euirc.net/openclonk-dev/ #openclonk-dev] on irc.euirc.net (Problems connecting? Use irc.ham.de.euirc.net) | * IRC - [irc://irc.euirc.net/openclonk-dev/ #openclonk-dev] on irc.euirc.net (Problems connecting? Use irc.ham.de.euirc.net) | ||
** [[ | * Bugtracker - [http://bugs.openclonk.org bugs.openclonk.org] | ||
* Forum - [http://forum.openclonk.org forum.openclonk.org] | |||
== Contribute Scripts or Game Content == | |||
Just like Clonk Rage before, most things in OpenClonk can be changed without touching the engine. Instead, we rely on a script language and a flexible game content system to make up our game content. This means that you can get involved easily - without having to learn C++ first! Traditionally, developing own objects and scenarios and sharing them with others has been how pretty much all of today's developers started out. | |||
* Developer Documentation [http://docs.openclonk.org/en/sdk/ docs.openclonk.org/en/sdk/] | |||
* Forum - [http://forum.openclonk.org forum.openclonk.org] | * Forum - [http://forum.openclonk.org forum.openclonk.org] | ||
* | * Style Guide - [http://wiki.openclonk.org/w/C4Script_Style_Guidelines wiki.openclonk.org/w/C4Script_Style_Guidelines] | ||
* | |||
== Build OpenClonk Yourself == | |||
But when delving deeper into OpenClonk, you will often find yourself in the situation that you need a closer look at what makes OpenClonk tick internally. At that point, it is a good idea to assume the perspective of developers - get the source code and build it in your own development environment. | |||
* Tutorial for Windows - [http://wiki.openclonk.org/w/Building_with_Windows wiki.openclonk.org/w/Building_with_Windows] | |||
* General instructions - [http://wiki.openclonk.org/w/Build_OpenClonk wiki.openclonk.org/w/Build_OpenClonk] | |||
* Mercurial Guide - [http://wiki.openclonk.org/w/Mercurial_Guide wiki.openclonk.org/w/Mercurial_Guide] | |||
* Mercurial Repository - [http://hg.openclonk.org hg.openclonk.org] | |||
* Source Code Structure - [http://wiki.openclonk.org/w/Source_code_structure wiki.openclonk.org/w/Source_code_structure] | |||
== Hack the OpenClonk Engine == | |||
Maybe you already are well-versed in C++ and want to help out actually diagnosing problems? Or - even better - have your own ideas on engine improvements? We are always glad to look at patches. | |||
* Wondering where to start? - [[GSoC2011Ideas|Ideas page]] | |||
* Debugging synchronization losses - [http://wiki.openclonk.org/w/Sync_losses wiki.openclonk.org/w/Sync_Losses] | |||
* Style Guide - [http://wiki.openclonk.org/w/Style_Guidelines wiki.openclonk.org/w/Style_Guidelines] | |||
== Legal Stuff == | |||
OpenClonk uses the ISC license for code (engine and script) and CC-by for most other media. Read more about the [[License | license stuff]] here. | |||
Revision as of 13:26, 2 October 2011
OpenClonk is an open project. That means it depends on people coming in and helping out. People just like you! This page should give you an idea what you could do in order to get involved.
Use Nightlies
OpenClonk is continously in development. The "current" version can change daily! If you want to follow the development, it is a good idea to make sure you are able to run development versions. You will not need to build them yourself - just use the nightly builds linked below and you should be ready to go.
- Nightly builds - www.openclonk.org/nightly-builds/
- Blog - blog.openclonk.org
- Changelog - hg.openclonk.org
- Browse source - hg.openclonk.org/file/
Report Bugs
We cannot possibly account for every possible configuration out there. If you see something that's wrong, we would really like to know about it. Especially if you are willing to actively work with us in finding a solution for the problem.
Here's how you can reach us:
- IRC - #openclonk-dev on irc.euirc.net (Problems connecting? Use irc.ham.de.euirc.net)
- Bugtracker - bugs.openclonk.org
- Forum - forum.openclonk.org
Contribute Scripts or Game Content
Just like Clonk Rage before, most things in OpenClonk can be changed without touching the engine. Instead, we rely on a script language and a flexible game content system to make up our game content. This means that you can get involved easily - without having to learn C++ first! Traditionally, developing own objects and scenarios and sharing them with others has been how pretty much all of today's developers started out.
- Developer Documentation docs.openclonk.org/en/sdk/
- Forum - forum.openclonk.org
- Style Guide - wiki.openclonk.org/w/C4Script_Style_Guidelines
Build OpenClonk Yourself
But when delving deeper into OpenClonk, you will often find yourself in the situation that you need a closer look at what makes OpenClonk tick internally. At that point, it is a good idea to assume the perspective of developers - get the source code and build it in your own development environment.
- Tutorial for Windows - wiki.openclonk.org/w/Building_with_Windows
- General instructions - wiki.openclonk.org/w/Build_OpenClonk
- Mercurial Guide - wiki.openclonk.org/w/Mercurial_Guide
- Mercurial Repository - hg.openclonk.org
- Source Code Structure - wiki.openclonk.org/w/Source_code_structure
Hack the OpenClonk Engine
Maybe you already are well-versed in C++ and want to help out actually diagnosing problems? Or - even better - have your own ideas on engine improvements? We are always glad to look at patches.
- Wondering where to start? - Ideas page
- Debugging synchronization losses - wiki.openclonk.org/w/Sync_Losses
- Style Guide - wiki.openclonk.org/w/Style_Guidelines
Legal Stuff
OpenClonk uses the ISC license for code (engine and script) and CC-by for most other media. Read more about the license stuff here.