Hey CryENGINEERS!

There are over 600 articles covering CryENGINE from beginning to end right here at freesdk.crydev.net

Updates?
With our documentation process, we update the articles internally and then push the updates to the live documentation site. There may be periods where the documentation doesn't receive an update for a while but note that we are still continuing to update it internally and will push these updates to the live site alongside SDK updates (updates to engine requires updates to documentation on new features, etc). You can see when documentation has been updated on the right of the homepage, under "Recent Updates"

Wish to make a request?
If you have a particular request you'd like to make for documentation, let us know here! Whether you're looking for particular information on something or have found an article that doesn't seem quite right, we're continually working on our documentation and will provide information where it's needed most, with your help.

Looking for more than just information? Need some tutorials?
We're currently putting together a "Community" section on the documentation site which will be home to community-made tutorials on CryENGINE. There are countless tutorials all over the web, from video to text and we're looking for the best ones to make understanding CryENGINE as easy as possible. If you know of any great tutorials, please let us know!

What documentation? Where?
From anywhere on CryDev, you'll find a link in the top menu called "Docs". This drop down menu gives links to our documentation for the Free SDK, C2 Mod SDK and our CryWiki installation, which contains lots of information for CryENGINE 2.

If you have any other suggestions for documentation in general we'd love to hear it, so please let us know your thoughts.

Thanks!

Maybe create a SVN system for get documentation in local..

(I work a lot in the train.. , i have the cookbook but is not a doc.. )

No others ideas, is very good doc !!!

Thanx !!

Would be really cool to get some more information about CryThreads and so on (with examples).

That 600 articles do not seem to be usefull for coding at all. And with this style it wont work even if it becomes 6000. Please tell your document writers to inspect some proper documentation on the web. We need api references, tecnical guides with example source codes for everything. Or this will continue to be only an engine of visual scene making.

Hello

As a request, it would be nice get a better explanation about the particle editor.

like in the Movement paramters,
-what is the Target Attraction part ?
-how that work ?
-what are the precise effect ?
-With exemple / screen to show the difference while tweaking thoses values

Same for the Advanced Tab
-What is the Fill cost rate ? how that work ? what the effects ?
-What is the heat scale ?
-the Force Generation is explained at the end, but somes extra exemple could be nice

Same for the Spawning part
Attach type / attach form would requier a bit more explanation / exemple / screens to perfectly understand how that work and what will be the difference, and in which case.

-------------------------------------------------------------------------------------------------------------------------

for weapon.xml
explain xml params name / make a list ?, what is the differents params usable ? effect ? in which case can we use them ?

most of the explanation are really too light to correctly understand in deep how that work.

@wootwoots
Look at the "SCAR.xml" file included with the free SDK. It pretty much explains everything.

Is "CryThreads" part of code or something? Just need to know what it is so i know who to ask

@tasadar - thanks for the feedback. Is information like API references applicable to the Free SDK though?

@wootwoots - we've just released the "Community" section in the documentation and i've started putting together some docs on that kinda stuff there

@CryAdam Yeah, it's part of the CryEngine3-Code.

Definitely! We're just starting to prototype for a student project. While I could get a sidescroller camera to work in FlowGraph within an evening together with a friend, our coder had severe problems digging into the code due to all the custom functions and complex links in the sample code. A good API reference is a must-have imho. If you can look up brief descriptions of classes, methods and functions with samples for instance, it will facilitate the getting into the code a lot!

About the community documentation: Is there a reason for no longer using the Wiki? How will community members be able to contribute?

The wiki remains for CryENGINE 2 use but we didn't wish to use the same software for the CryENGINE 3 documentation. Instead, we're using the same software we use internally which means it's simple for us to push updates to the live documentation.

Thanks for the info and i'll pass it on

not really there is plenty of xml params present in somes Crysis2 weapons unexplained in the free sdk scar.xml
And since the free sdk scar.xml have the same structure, i suppose thoses C2 params can be used too in the free sdk ( i can be totaly wrong of course )

+ in the scar.xml what is the "hints" part ? what is the "frequency" (exemple mike tracer have a value of "2" instead "1" ) params in the tracer part, or the attachment part is very light, etc.

the scar.xml is good for the begining, but the explanation do not really go in deep, like giving all params possible per part and explain each effects. And finaly C2 weapons.xml learned me a lot of more than the free sdk scar.xml.

thats why i was saying that

Have you seen this: http://freesdk.crydev.net/display/COMMU ... L+-+Weapon

Still WIP but should serve as a pretty good reference for most things.

the documentation must be multilanguage ....most of the american continent speak spanish

Console Commands and Variables
http://freesdk.crydev.net/display/CRYAUTOGEN/Home
This page contains a list of commands' names, it would be more convenient for beginners to have a page with a full page with names and descriptions, e.g.:


It would be much more easier to find a command by description. You don't need to open each category and perform a search there. For example, I want to find if it is possible to enable third person view and what commands do I need to control this view. I open the doc page http://freesdk.crydev.net/display/CRYAUTOGEN/Home and press Ctrl+F in my browser. I search for "third" or "3rd" or "person" and nothing is found. The built-in site search doesn't help also. Eventually I end up searching forums for the necessary command.

It would be good to have a link "All in one page" on the commands doc page.

Regards

http://freesdk.crydev.net/dosearchsite. ... rUsername=

You can specify which spaces to search in in the search results. Having every single description for every single command (some of them being huge on their own) would make the page unusably long. For those who want to search particular commands/descriptions, the ability to do so is available