DevelopersFAQ

Version 7 (kaetemi, 05/06/2010 11:15 pm)

1 1 sfb
{{toc}}
2 1 sfb
3 1 sfb
h1. Developers FAQ
4 1 sfb
5 1 sfb
h2. Is there a Ryzom Project Roadmap?
6 1 sfb
7 3 sfb
Yes, there's a link on the top of the page and you can access it "here":http://dev.ryzom.com/projects/ryzom/roadmap
8 2 vl
9 3 sfb
h2. I'd like to add a feature to Ryzom. What do I do?'
10 1 sfb
11 3 sfb
The very first thing you should do is start talking with members of the community. It helps to know how your feature is going to fit, what is involved in your feature and whether it will eventually be accepted and merged into the central repository. It's helpful to start with [[HowToReportBugs|reporting bugs]], [[HowToSubmitPatches|submitting patches]] or [[HowToRequestFeatures|requesting features]] documentation. If you're a programmer and want to jump head first into coding please review [[CodingStandards|coding standards]].
12 3 sfb
13 1 sfb
h2. I'd like to start my own project based on Ryzom. Can I do this?
14 1 sfb
15 3 sfb
Of course, there are no limitations to what you can do with the Ryzom source, libraries, tools or media so long as you abide by our [[Licensing|licenses]], respect the Ryzom trademark and abide by the Ryzom Game's "Terms of Use":http://www.ryzom.com/en/policies.html#legal_termofuse and "End-User License Agreement":http://www.ryzom.com/en/policies.html#legal_eula which includes using the Ryzom source code to create hacked or otherwise modified clients to connect to the "Ryzom Game":http://www.ryzom.com. 
16 1 sfb
17 3 sfb
Here are some examples of things you could do with Ryzom:
18 3 sfb
19 3 sfb
* Use the Ryzom source code and create new data to create your own universe.
20 6 kaetemi
* Use the Ryzom source code and the graphics asset to create a parallel Ryzom universe with an entirely unique storyline.
21 3 sfb
* Use the Ryzom graphics assets to create any other sort of game such as offline RPG, puzzle games, etc.
22 3 sfb
23 7 kaetemi
What you cannot do is to use Ryzom trademark, nor names proprietary to the Ryzom Game (creatures, NPCs, location names), or use some modified code to hack/cheat on official Ryzom servers.
24 2 vl
25 1 sfb
h2. Can I sell projects based on Ryzom or charge for subscriptions?
26 1 sfb
27 2 vl
If you reuse the graphics assets of Ryzom for your own game/project, you can sell it, just follow "Creative Commons License Attribution-Share Alike 3.0":http://creativecommons.org/licenses/by-sa/3.0/ license.
28 2 vl
29 2 vl
If you reuse the source code of Ryzom for your own game/project, you can sell it but you have to follow the term of the "AGPLv3":http://www.gnu.org/licenses/agpl-3.0.html license. For example, you'll have to release the source code of your project under the same AGPLv3 license (the client *and* the server).
30 2 vl
31 1 sfb
h2. How do I get the source code?
32 1 sfb
33 2 vl
Please follow the instruction on [[Getting Source|this page]].
34 1 sfb
35 1 sfb
h2. How do I build the source code?
36 2 vl
37 5 Krolock
Please follow the instruction on [[BuildForWindows|this page for Windows]] and on [[BuildForLinux|this page for Linux]].
38 1 sfb
39 1 sfb
h2. Can I do anything I want with the Ryzom source code?
40 2 vl
41 1 sfb
Yes, it just have to follow the rules written in the "AGPLv3 license":http://www.gnu.org/licenses/agpl-3.0.html.
42 1 sfb
43 1 sfb
h2. There's something I want to do but I'm not sure how?
44 1 sfb
45 3 sfb
No problem! Please come chat with us or post on the forum. You can find more information on contacting the community [[Contact_the_community|here]].
46 1 sfb
47 2 vl
h2. Who can answer questions about changes I would like to make?
48 2 vl
49 3 sfb
You have an idea or questions please [[Contact_the_community|contact the community]].
50 1 sfb
51 2 vl
h2. If I find a bug and have a fix for it how do I submit it?
52 2 vl
53 3 sfb
That's great! 
54 3 sfb
55 3 sfb
It's helpful to start with the information on [[HowToReportBugs|reporting bugs]] and [[HowToSubmitPatches|submitting patches]]. Before you begin writing actual code you should read our [[CodingStandards|coding standards]]. Once you're ready you'll want to create a "new issue":http://dev.ryzom.com/projects/ryzom/issues and attach the fix so we'll be able to review it and integrate it.
56 2 vl
57 1 sfb
h2. What's more important: fixing bugs or adding features?
58 2 vl
59 4 kaetemi
Both are important. Some people love to find and fix bugs some other love to add new features. It depends on you and what you want.