Torque 3D Open Source Update: Template Refactor

Planning discussion

For utmost flexibility it is my belief that the Template(s) should be a minimal and genre-agnostic framework for the end-user to build upon. Unfortunately, as it currently exists, the Full Template contains some FPS-centric elements, and other bloat, that clouds the issue of just what is necessary for a minimal script base. Removing these extraneous features will help establish an initial effort in a longer term goal of refining and refactoring our basic Template offering, making it cleaner as well as easier to support the evolving needs of the community.

I submitted a detailed outline to the Steering Committee of what I was wanting to remove or modify for their thoughts in refining a course of action, which in summary could be outlined like so:

• Remove unused/legacy global variables
• Correct the cause of some console warnings and/or errors
• Asset cleanup to avoid duplication
• Remove the FPS specific features
• Reduce complexity of stock scripts
• Directory restructuring

From that list of actions I proposed a plan for a "starter" template that genre specific Templates such as FPS Template, RTS Template, etc., could be built from.

The Starter Template would contain the script necessary to:

• Initialize all sub-systems
• Demonstrate a full but basic user interface (console, main menu, level select, server join/host, options, etc.)
• Load a level
• Provide an example shape and required datablock/scripting for each object class.
• Demonstrate how to drop a player into a mission in either in 1st or 3rd person perspective.
• Demonstrate minimal gameplay rules for ending the game or advancing to another level. Additional gameplay aspects would be specific to the various Genre Templates.
• Provide support for the GUI and World Editor tools.
• Retain standard package and/or mod support

Additionally, but of lesser of importance, would be an even more stripped down template; a "Barebones Template" that would contain the minimal script necessary to:

• Initialize all sub-systems
• Provide access to the console
• Provide support for the GUI and World Editor tools

Workflow and Progress Report

Initially I had organized three different template projects (FPS, Starter, Barebones) that I was working on at once. This proved tedious.

To shortcut the whole process I re-purposed the current Full Template to become the FPS Template, which will then be stripped down even further to become the Starter Template. This more easily prevents having to work across several different templates at once, performing the same steps over and over within the duplicate tools and core directories.

And that is where I am at now. There may still be some minor fixes and cleanup that could be implemented, but the bulk of the work is done and I am ready to begin the directory restructuring phase. It is at this point that it was suggested that we approach the community for feedback in regards to the plan for this directory restructuring.

Community Interaction

What this means in consideration of my plan will be the merging of the "core" and "game" packages. This merge would combine both sets of scripts and assets reducing a layer of complexity -- with no loss of functionality! We have yet to decide just how to setup the new structure, but basically it could go one of two ways:

1. Move the current "game" mod (art, levels, scripts) into the baseline"core" module.
2. Explode the "core" out and into the "game" mod package.

I don't really favor one direction over the other. Moving things into the core would be the easiest to do since there are texture and gui assets that are hardcoded in the source to be found in the core/art directory. But there is a goal that we are investigating to remove these hardcoded filepaths. If this is accomplished, then that would make it much easier for anyone to implement a directory redesign of their own.

One of the biggest concerns that arose in our discussion was that significantly altering the directory structure would in essence break the instructions for every existing Resource, tutorial, content pack installation, etc. Third party content developers and tutorial writers are going to hate me for that!

So this the question that we pose to you, the community: do you want to see backwards compatibility maintained, or would you rather see the Template broken down and rebuilt from the ground up to be more flexible -- and easier to use -- for end-user and future development? If the latter, are there any suggestions about the direction of the core / game merge?

Moving Forward

Keep in mind that this is not to be taken as a promise of a course of action, only as an indication of the possibilities we are investigating in the committees' ongoing effort to streamline and codify a working roadmap. Each one of us in the steering committee has expressed a desire to maintain transparency to the community. Knowing more about what you all want, or even just how it makes you feel, from the various things we are working on helps us better evaluate the direction that is most beneficial.