FOnline Development > Questions and Answers
English SDK documentation
cthulchu:
he was making fun of me. Dude, I don't rly need the doc cuz I have it. I believe it would be nice if someone who needs it would work on it and I offered my help with it.
K4thos:
--- Quote ---If people are interested, they could start translating the russian documentation ( http://docs.fonline.ru/ ) first with google translate, adding their comments somewhere in Google docs (cuz it's editing and "version control" capabilities are amazing). The russian doc is, basically, a manual to 2238's codebase. Helped me a lot. I found solutions I wasn't expecting initially.
--- End quote ---
So there is at least online version of the docs. Thanks for the link.
What scares me off is this part:
"Актуальность документации: ревизия №396 SDK." which translates to "Relevance of the documentation: revision number 396 SDK.". Is this really the case? We are at SDK revision 791, there's no way I will opt out from few years of engine improvements, if I'm going to start a new project.
--- Quote ---Best and only documentation is SDK commit log, period.
FOnline documentation always has been outdated, even russian one, so you can imagine how behind english one is :) What you'll get from BuildEn* are basics really; good for start but sooner or later you'll reach stage "there's no way X is not implemented" - that's when you should switch to commit log. I've been there, started with english .chm, then translating russian one, and log as last step.
As cthulchu mentioned, Google Translate is your only sane option (beside fellow russian-knowing dev, ofc), and let me tell you, it improved a lot when it comes to translating code-related stuff. There is still some gibberish around -checked random commits few months back- but it's just few words/sentences overall, you don't have to decipher half of entry with two other devs ;D
--- End quote ---
sounds like a madness to me o,O There's not even a demo that could be used as a base to understand the SDK (TLA seems to be stacked on REV 412 codebase). Based on the info in this topic it looks like the engine has been created with TLA and now Last Frontier in mind, not as something for community projects.
devis:
cthulchu:
devis, stop offtoping please.
K4thos, 2238 stopped around 2013. it uses around 396th rev. The last stable rev is 412, I think. So the documentation is all about the 2238 engine everyone seems to be using.
Maybe except a few russians, who use cvet's help in developing pretty sad ptw projects mainly for poor russians.
Ghosthack:
--- Quote from: K4thos on September 01, 2017, 12:04:19 am ---Based on the info in this topic it looks like the engine has been created with TLA and now Last Frontier in mind, not as something for community projects.
--- End quote ---
This is correct. While 2238 was still in development (2009-2013) we had some limited input on Cvet's development for things that we needed/wished but we pretty much had to follow along with all the engine changes as they came, resulting in a ton of work merging changes. And since we had a lot of different ideas from TLA, that's why the code bases diverged so much from each other.
As for docs in general, yes, they were never great, neither 2238 docs or FOnline SDK docs. Looking at the code and trying stuff have always been the way forward. Making good docs and keeping them up to date is a lot of work and probably not the most fun thing you can do with a non-profit hobby project.
Navigation
[0] Message Index
[#] Next page
[*] Previous page
Go to full version