Torque Game Builder (TGB) Documentation Overview

As a TGB user, you have a ton of great documentation and tutorials available to you! This page offers a quick overview of what's available.

There are two main places to get detailed TGB documentation: online at the Torque Developer Network (TDN) and here in the TGB SDK installation on your hard drive itself. The Torque Developer Network is a vibrant, community-oriented online documentation site for TGB and other GarageGames technologies. More information on the documentation available in each place is available in the table below.

Documentation in the TGB SDK

Documentation Online

TGB ships with a large amount of documentation right in the SDK. The documentation is divided up into three different categories:

Tutorials
(tutorials are listed in order of complexity and should be completed in this order)

  1. Fish Demo Tutorials - starting with Introduction.pdf
  2. - The Fish Demo Tutorials are great for those new to TGB and those new to scripting in general. Many of the TGB scripting basics are detailed in an easy to follow, step by step process that anyone new to TGB should be able to approach and learn from.

  3. Fish Game Tutorials - starting with Starting Out.pdf
  4. - The Fish Game Tutorials are a great second step. In these tutorials you will now add a fish that you can control through your keys. Objectives, goals, and challenges are added in these tutorials as well to make a simple fish game.

  5. Whack-A-Mole Tutorials - starting with Create a Mole.pdf
  6. - The Whack-A-Mole Tutorial steps you through creating a fun and simple game based on "whacking" a mole with a hammer, reliving the days of being a kid and going to an arcade with good hammer stomping.

  7. Shooter Tutorial - starting with Shooter Tutorial.pdf
  8. - The Shooter Tutorial instructs you in creating a bare bones shooter game in TGB (recreating some of the basics of the demo).

  9. Checkers Tutorial - starting with Starting Out.pdf
  10. - The Checkers Tutorial covers TGB's networking system by creating a networked checkers game.

Feature Tutorials
(feature tutorials step you through utilizing the TGB Level Builder, one feature at a time)

  • Workspace
    - Steps you through setting up your Level Builder workspace and utilizing some features you may not already know.

  • Static Sprites
    - Covers bringing images into the Level Builder with the Image Builder, dragging them into your level.

  • Animated Sprites
    - Instructs on creating animations out of images with the Animation Builder and adding them to your level.

  • Scrollers
    - You will learn how to bring scrollers into your level and set them to scroll and repeat.

  • Particle Effects
    - Demonstrates how to manipulate a 3D Shape in TGB.

  • Tile Maps
    - Steps through the process of creating a Tile Map in the Tile Map Builder and bringing it into a level.

  • Paths
    - Details how to create and utilize paths.

  • Collision
    - Explains the important factors in setting up objects for proper collisions.

  • Mounting
    - Explains how to mount objects and take advantages of this robust system in TGB.

  • World Limits
    - Explains how to apply world bounds to objects.

  • Config Datablocks
    - Covers the purpose and usage of configuratin datablocks.

  • Packaging Utility
    - Steps through the creation and packaging of a simple project.

  • Resources
    - Teaches how to create your own resources.

  • Audio
    - Explains how to create and manipulate audio in TGB.

  • File IO
    - Demonstrates simple reading and writing of files.

References
(references provide a detailed look at a specific aspect of the engine)

  • TGB Reference
    - An invaluable reference of TGB objects with their appropriate functions, callbacks, and fields.

  • TorqueScript Overview
    - Describes the features of TorqueScript and how to use the language.

  • TorqueScript Reference
    - A quick reference to the syntax of TorqueScript.

  • Input Interaction
    - A great resource on setting up your scripts to respond to key and mouse events in TGB.

  • Image Maps
    - Covers all of the options you get when bringing an image into TGB.

  • Particle Engine
    - Explains the robust and powerful particle engine in detail.

  • Debug Banner
    - Details the information provided by the debug banner, invaluable for tweaking game performance.

  • Common Directory
    - References everything you might not have known about the common folder.

All told, TGB ships with over 300 pages of documentation right in the SDK! And since its all in PDF format, you can print any and all of it, if you want. Of course, you should know that you don't need to read all of this information to get started with TGB. In fact, just the opposite is true! Most people just read a few tutorials and start working on their own from there. That's all you really need to do... and if you end up having questions later, you can search for answers in the excellent documentation here in the SDK, and online.

Please note as well that all the documents available here in the TGB SDK are also avialable online at the Torque Developer Network.

There is a great wealth of tutorials and documentation available for TGB online. The main sources of documentation online are the Torque Developer Network and the GarageGames website. The documentation available on these sites can be categorized as below.

There are more and more TGB tutorials and references being created online every month at TDN, so be sure to bookmark that page and check back often! Already, there are over 500 pages of documentation available online at TDN for TGB. But remember, you don't need to read any of it to get started! Start at your own pace, and use TDN as a way to answer questions and learn more as you go along.

Remember, you must log in to TDN before you can access the TGB tutorials, so be sure to click the login link!