Game Development Community

Where are the voluminous documentation promised? missing .pdfs

by Wolf Dreamer · in RTS Starter Kit · 09/27/2006 (10:27 am) · 6 replies

Http://www.garagegames.com/products/54
Quote:
Included documentation explains the code and technology so that you not only have a start on your Real Time Strategy game, but you learn each step of the way.

Quote:
GarageGames is becoming known for its voluminous documentation and the RTS Starter Kit is no slouch. The docs explain each of the systems in the Starter Kit, and the simple example game the pack ships with has well-documented source-code to demonstrate how to use the systems in the pack in a hands-on fashion.

I don't see all this documentation anywhere at all. I used Windows XP search to look for every pdf, html, and doc file in my RTS Starter Kit folder, and it wasn't there. I don't see a large amount of information on the internet either.

I do see this over at the wiki.
Quote:
RTS-SK code getting started 1 - A general guide to working with the RTS-SK. This explains how to get the most out of the starter kit. How to answer your own questions. This guide will save you pain. Read it.

RTS-SK code getting started 2 - A general guide to working with the RTS-SK. This explains how to get the most out of the starter kit. How to answer your own questions. This guide will save you pain. Read it.
Where are these files at? Did the download have another bug, which prevented me from getting these? Where do I find them?

#1
09/27/2006 (10:54 am)
http://tdn.garagegames.com/wiki/RTS_Starter_Kit

file:///C:/Torque/RTSStarterKit/example/docs/Manual.html - (Depending on where you installed the RTS Starter Kit)

These are two places to start for learning specifically about the RTS Starter Kit.

Quote:Unfortunately, this documentation is no replacement for a good understanding of programming and Torque. Although there are portions of this Kit that are easy to use for even the most inexperienced developer, to really get the most out of it you should make sure you have good understanding of Torque. The best place to start is at the Torque Documentation page, by reading through the getting started guide, and the Source Code Documentation/Engine Reference. If you don't feel confident working in C++, pick yourself up a good book on the language, or find some online tutorials. Start with small projects and work up! Don't be afraid to ask questions, though you should always try to answer your question on your own first.

This was taken straight from the beginning of the RTS Documentation Manual
#2
09/27/2006 (11:25 am)
Yeah, that one page manual.html file is so useful.

Where are the mentioned RTS-SK code getting started 1 and 2 at though? Did those files ever exist? Why are they listed on the wiki?

And on the sales page, it clearly says there is a lot of documentation included for the RTS, not just the Torque documentation.

And yes, I see the 10 articals under RTS-SK Coding Essential Articles on that page. I didn't really consider that the promised voluminous documentation. I assumed there was more which was suppose to be included with the download.
#3
09/27/2006 (11:35 am)
Thomas,

What information do you need?

The manual.html file has a bunch of links that lead off to other docs. TDN has in depth articles about the features in the RTS Starter Kit? What exactly are you looking for?
#4
09/27/2006 (11:46 am)
Yeah, I see that file has links to two things concerning documentation.
Quote:
# Torque Home Page - great source of information about Torque in general; tutorials and the hub for all official Torque documentation.
# Torque SDK Documentation - Home of more hardcore documentation. The General Torque Documentation can be found here, as well as the Source Code Documentation, AKA the Torque Engine Reference. The Engine Reference contains a full class hierarchy, as well as reference information for every class in the engine. (Naturally, it doesn't cover RTS specific constructs!)

I was just concerned about the two files mentioned on the wiki, and do they exist or not? If not, take them off the list there, because that does lead to some confusion, as evident by the post people have made sporactically over the past 6 months, asking where they could be found at.

Quote:
RTS-SK code getting started 1 - A general guide to working with the RTS-SK. This explains how to get the most out of the starter kit. How to answer your own questions. This guide will save you pain. Read it.

RTS-SK code getting started 2 - A general guide to working with the RTS-SK. This explains how to get the most out of the starter kit. How to answer your own questions. This guide will save you pain. Read it.
Its just weird to tell people to get started by reading two files that don't exist. I just assumed at one time they did, and there was just a mistake where you forgot to include them in the RTS Starter Kit download. If they never existed, just something planned but not completed, then please remove that from the wiki.
#5
09/27/2006 (11:47 am)
Yeah, I see that file has links to two things concerning documentation.
Quote:
# Torque Home Page - great source of information about Torque in general; tutorials and the hub for all official Torque documentation.
# Torque SDK Documentation - Home of more hardcore documentation. The General Torque Documentation can be found here, as well as the Source Code Documentation, AKA the Torque Engine Reference. The Engine Reference contains a full class hierarchy, as well as reference information for every class in the engine. (Naturally, it doesn't cover RTS specific constructs!)

I was just concerned about the two files mentioned on the wiki, and do they exist or not? If not, take them off the list there, because that does lead to some confusion, as evident by the post people have made sporactically over the past 6 months, asking where they could be found at.

Quote:
RTS-SK code getting started 1 - A general guide to working with the RTS-SK. This explains how to get the most out of the starter kit. How to answer your own questions. This guide will save you pain. Read it.

RTS-SK code getting started 2 - A general guide to working with the RTS-SK. This explains how to get the most out of the starter kit. How to answer your own questions. This guide will save you pain. Read it.
Its just weird to tell people to get started by reading two files that don't exist. I just assumed at one time they did, and there was just a mistake where you forgot to include them in the RTS Starter Kit download. If they never existed, just something planned but not completed, then please remove that from the wiki.
#6
09/27/2006 (12:21 pm)
It's a wiki, with information generated by the community. Just because the link exists doesn't make it a "promised document from GarageGames", or anything of the sort.