Why WAS Torque3D documentation so poor?

#261 @Sei - They had a post a while back promising that 1.1 doesn't ship without full API docs. So the answer is yes! :)

...unless the old GG takes over...

#262 a

#263 What happened to your post Andy?

#264 I was wondering the same. I got an email with it...

Anyway, what's the status on the new blog post Mich?

#265 lol, I deleted it as I realised it was a pointless post -- been listening for 18mths that things will improve on documentation and just feel let down on the promises.

Torque is what it's always been great, cheap tech with shitty documentation and another post whinging about it won't change that - main difference now is there's shinier features and a bigger price tag.

#266 @Glen - I have a draft written up. Waiting for the "go ahead" and images.

#267 Cool, looking forward to the new draft. I'm really hoping for the docs after all the website work that we're doing is over. I do want to start working with T3D when all the other work is done.

edit: actually I'm hoping for 1.1 by then, there's alot of problems in 1.01.

Good luck Mich, and I hope you guys can release soon.

#268 Any news on the new doc release?

#269 It's been months since I last inquired about how poor the documentation is. It's June 21st. What's taking so long? I basically have software I can't use because there's no books, docs, etc to show me how. Sigh.

#270 @Frank - As to why this is taking so long, the same reason why they have never released it in the first place. GarageGames is about marketing and hype and not about developing a useful product. GarageGames lacks focus in general. As long as they try develope more than 1 or 2 engines at a time, they will never deliver a product that measures up to the competition.

#271 Update: We have been making progress on updating the documentation. The two new writers are heads down and we have been generating content for both written tutorials (such as a new software setup doc) and script API reference. For the script reference, we have been knocking out entire directories. For example, we just wrapped up FX, which covers:

• Lightning
• Explosion
• Replicators
• Ground Cover
• Particle
• ParticleEmitter
• ParticleEmitterNode
• Precipitation
• Splash
• WindEmitter

We also have updates to the Player, Vehicle, and COLLADA/Shape related classes. The new formatting and organization overhaul is complete. In the following week we will be taking care of:

• decalData
• decalManager
• guiClockHud
• guiCrossHairHud
• guiHealthBarHud
• guiShapeNameHud
• Debris
• pathCamera
• projectile

Essentially, each week we are filling in huge chunks missing from the script reference. It seemed like an insurmountable task, but I believe we will still deliver on the promise of a complete script reference for the 1.1 full release.

#272 Cool, is there a possible release as of yet or is it still "when it's done"? ;)

edit: I say cool too much in these posts...

#273 @Michael:

Just an idea:

Give the T3D professional owners access to the docs in its current state. By doing so you might be able to get feedback on any flaws in the docs before the final release.

#274 second that...also it is way too long waiting already. Originally T3D was promised to be released with all these docs available, it did not happen, now it's already some months later...please release what you have continually. This way at least there is something more available.

#275 Thanks for the update.

#276 @Richard and Andy - The first set of drafts were released a while back: T3D Script Manual Draft. I can't push the new html docs yet, but I'll try to find a way to upload the new CHM using a different server.

#277 very nice michael, thanks. Besides the T3D Script Manual, will there be more tutorials in the 1.1 release? Is there somewhere some kind of "table of contents" about the full T3D 1.1 docs?

#278 @Andy S. -

Quote:Besides the T3D Script Manual, will there be more tutorials in the 1.1 release?

Yes. We have a writer dedicated to creating tutorials. We know for sure there will be a new software setup guide that will be current and contain better instructions. On the roadmap for T3D 1.1, we have discussed the following for tutorials:

* Updating the RTS Tutorial
* Guide based on adapting the engine for your project.
* World Editor Application and tricks (possible only cover this if it directly related to the scripting tutorials)
* Game mechanic scripting. (Mini projects)

The manpower break down is as follows:

- 1 person dedicated to handwritten tutorials
- 1 person dedicated to filling in the T3D Script Manual
- 1 person working on the art pipeline docs (Chris Robertson)
- All programmers writing new code will adhere to the new documentation standards for the script manual
- Myself managing the doc projects and writing for both tutorials and the T3D Script Manual

Additionally, I am looking into contracting a few artists to help fill in the artist docs, since they are extremely lacking. Compare this manpower to me working by myself for a solid year with occasional contributions from artists on the team.

#279 thanks michael for the detailed answer! This looks really good, can't wait till 1.1 releases. I think if you manage to deliver this with 1.1 then T3D finally has (beginner-ready) docs on par with or better than unity.
On a side note, since you sell Houdini trough GGs webspace, it would be nice if there would be also docs regarding how to produce content with houdini. I think for any developer on a budget, houdini with the dts exporter offers the best bank for the buck (except blender), and it would be really nice to have more docs, tutorials and examples on how to create and get content from houdini into T3D.

#280 @Michael:
Thanks a lot for the details.
Obviosly running in changed interfaces I had a lot of problems with the tutorials (especially the RTS) and they seemed kindof useless. Besides I learnt a lot about the console functions and system.
An update of the documentation in line with the development of T3D is essential for the use of the engine.

But you will make it, I can´t await the release!