Difference between revisions of "Development:CyanWorlds.com Engine"
Tsar hoikas (Talk | contribs) m (→Contributing) |
Tsar hoikas (Talk | contribs) |
||
| (10 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | The Guild of Writers development team, H'uru, is currently developing a fork of the [[CyanWorlds.com Engine]] | |
| + | (formerly known as Plasma). This article provides information on the development process of this fork. | ||
| − | = | + | == Building == |
| − | + | If you want to build CWE for yourself using H'uru's fork, you should consult the [[CWE:Getting Started|getting started tutorial]] to help you compile and set up a fully working client. Additionally, a (slightly outdated) [http://www.youtube.com/watch?v=HZbMf5W67UI video tutorial] has been made available. | |
| − | = | + | == Contributing == |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
GitHub provides a robust set of tools to allow you to easily share your changes with the main Guild repository. These tools revolve around two concepts: forks and [http://help.github.com/pull-requests/ pull requests]. | GitHub provides a robust set of tools to allow you to easily share your changes with the main Guild repository. These tools revolve around two concepts: forks and [http://help.github.com/pull-requests/ pull requests]. | ||
| Line 53: | Line 14: | ||
Once you are satisfied with your work, you should issue a [http://help.github.com/pull-requests/ pull request], which will let us know that you are ready for your changes to be merged into the main branch of development--the master branch. Once you have submitted your pull request, we will review your code and ask any applicable questions. Once your code passes our review(s), we will merge it into the master branch. | Once you are satisfied with your work, you should issue a [http://help.github.com/pull-requests/ pull request], which will let us know that you are ready for your changes to be merged into the main branch of development--the master branch. Once you have submitted your pull request, we will review your code and ask any applicable questions. Once your code passes our review(s), we will merge it into the master branch. | ||
| − | ==Code Guidelines== | + | === Code Guidelines === |
To improve the chance of your contributions being accepted, please consider the following guidelines. | To improve the chance of your contributions being accepted, please consider the following guidelines. | ||
| − | |||
* Indentation should be 4 ''spaces''. '''Tabs will not be accepted.''' Be sure to change your Visual Studio text editor settings to ''insert spaces'' if you have not already! | * Indentation should be 4 ''spaces''. '''Tabs will not be accepted.''' Be sure to change your Visual Studio text editor settings to ''insert spaces'' if you have not already! | ||
| + | * More detailed code guidelines are maintained on [https://github.com/H-uru/Plasma/wiki/Preferred-Code-Style Github] | ||
| + | |||
| + | == Roadmap == | ||
| + | Short version: There is none. This is open-source software, and each developer works on what he (dis)likes most. Since we do that in our free time, there is little point in trying to make us do something we do not want. | ||
| + | |||
| + | That said, the efforts of many developers are currently aimed at making CWE cross-platform, so that it runs natively on Linux and Mac. This requires rewriting the network code, replacing the physics engine and adding an alternative rendering backend. Another major goal is to eliminate code duplication and code smells. However, if you want to work on any other area, that's perfectly fine! Here's the current [[Open Source Task List|task list for open source]]. There is also an alternate roadmap being maintained by developers on [https://github.com/H-uru/Plasma/wiki/Roadmap Github]. | ||
[[Category:Projects]] | [[Category:Projects]] | ||
| + | [[Category:CWE]] | ||
Latest revision as of 20:38, 5 January 2016
The Guild of Writers development team, H'uru, is currently developing a fork of the CyanWorlds.com Engine (formerly known as Plasma). This article provides information on the development process of this fork.
Building
If you want to build CWE for yourself using H'uru's fork, you should consult the getting started tutorial to help you compile and set up a fully working client. Additionally, a (slightly outdated) video tutorial has been made available.
Contributing
GitHub provides a robust set of tools to allow you to easily share your changes with the main Guild repository. These tools revolve around two concepts: forks and pull requests.
Using a GitHub fork, you can develop your changes in a repository that you have full access to. Once you're ready to share that change, you can issue a pull request. The GoW development team will be notified and we'll review your changeset for inclusion. After a few good patches, you will probably be offered direct access to the GoW repository, meaning faster turn around for your patches and less management work for the core dev team.
It is recommended that when you begin work on a bugfix or feature, you do so in a git branch. This will make it easier for us to merge your changes into the main repository. Try to avoid merging other branches into your work branch (including updates to master). The cleaner your branch is the easier it will be to integrate.
Once you are satisfied with your work, you should issue a pull request, which will let us know that you are ready for your changes to be merged into the main branch of development--the master branch. Once you have submitted your pull request, we will review your code and ask any applicable questions. Once your code passes our review(s), we will merge it into the master branch.
Code Guidelines
To improve the chance of your contributions being accepted, please consider the following guidelines.
- Indentation should be 4 spaces. Tabs will not be accepted. Be sure to change your Visual Studio text editor settings to insert spaces if you have not already!
- More detailed code guidelines are maintained on Github
Roadmap
Short version: There is none. This is open-source software, and each developer works on what he (dis)likes most. Since we do that in our free time, there is little point in trying to make us do something we do not want.
That said, the efforts of many developers are currently aimed at making CWE cross-platform, so that it runs natively on Linux and Mac. This requires rewriting the network code, replacing the physics engine and adding an alternative rendering backend. Another major goal is to eliminate code duplication and code smells. However, if you want to work on any other area, that's perfectly fine! Here's the current task list for open source. There is also an alternate roadmap being maintained by developers on Github.