It's here! The MIT licensed Torque 3D GitHub repo is ready!
by Dave Wyand·
09/20/2012 (11:18 am) ·
It’s here! The MIT licensed Torque 3D GitHub repo is ready!
The day you’ve all been waiting for has arrived. The MIT licensed version of Torque 3D is now available on GitHub. For those that just want to jump in and fork or download the engine, the links to the two repositories on GutHub are listed below. Just promise to come back and read the rest of the blog, OK? (We especially want you to check out and share our new services page)
We are expecting that moving Torque 3D to a MIT license will greatly expand both the engine’s reach and our community. That means more developers to talk with, a larger audience for your tools and art packs, and more games, simulations and other products being created and released.
Working with Torque 3D
We have chosen to use GitHub to host the Torque 3D repositories. GitHub has become the place for open source projects on the Internet and makes it easy for the community to participate in growing a product. You’ll want to create a GitHub account if you want to do anything more than just download the current version of Torque 3D.
Today there are two separate public repositories for Torque 3D. The first is the master branch for Torque 3D’s source code and four project templates. This contains the latest stable version of the game engine and is nearly identical to the T3D 1.2 retail version. If you wish to use GitHub for your own development then you will want to fork the master branch and then clone it to your local computer.
If you’re not familiar with using the Git distributed revision control system, the GitHub website has a lot of useful information at help.github.com. I also highly recommend their GitHub for Windows and Mac tools. These tools make it easy to clone a branch to your computer to start working with the files, commit changes locally, and finally synchronize your changes back to your branch on GitHub. GitHub also provides a Subversion view into their repositories if you so desire.
If you’re looking to just download the current version of Torque 3D to your computer, GitHub will automatically generate a ZIP archive for you at any time.
You may then use Torque 3D just as you would have used the retail version, and may upload the files to your own code repository if you desire. Just because we chose GitHub for Torque 3D doesn’t mean you have to use it for your projects.
In addition to the master branch, a development branch is also available. This is where all of the bug fixing, system enhancements, and new features will initially be placed. This branch is not considered as stable as the master branch as it hasn’t gone through the full Quality Assurance process yet. If you want to have the latest version and are prepared for frequent updates then you’ll want to fork the development branch. Over time the work done in the development branch will be merged back into the master branch as outlined in the product’s roadmap (which, at this time, still needs to be defined by the Steering Committee).
The second Torque 3D repository holds all of the reference documentation that was available with T3D 1.2. This includes the TorqueScript reference in a Windows CHM file, as well as the offline documentation that describes how to use Torque 3D’s tools to build your game or simulation. As with the main code repository, there are master and development documentation branches that keep up with the matching branches in the code repository.
With both of these public repositories everyone has Read Access starting today! Just use the links at the top of this blog to get started.
Discussing Torque 3D
The GarageGames web site has always been about the community, which really has been our greatest asset. With the move to an open source Torque 3D we will continue to offer a focal point for the community.
In the past we’ve maintained a private forum for Torque 3D owners, and a public forum for those using the demo of T3D. Starting today, we will be moving to the following forum structure:
Both of these forums will be open to the public and you are free to post to them with your GarageGames account. However, these two forums will be moderated differently. Please see the sticky thread at the top of each forum for more information.
How do I participate in growing Torque 3D?
In order for Torque 3D to grow we need your help and that of the community. Many of you have already been doing this by submitting bug fixes to the forums and new resources. I don’t believe that this needs to change, especially for engine modifications that may be too specialized to be included in the master or development branches.
However, if you would like to take a more active approach to help grow Torque 3D then you can jump in and start using GitHub’s community development features. For submitting bug fixes, and enhancement or feature requests GitHub has an easy to use ticketing system found under the Issues tab of a repository.
From here you may create a ticket and give it an appropriate label (Bug, Feature Request, etc.) so it may easily be tracked. The Steering Committee will then review the ticket, add it to an appropriate Milestone, and assign the ticket to a user as required.
If you’d like to contribute code changes back into Torque 3D then you’ll want to fork the development branch. This creates a copy of the development branch for you to work with and check in your own changes. GitHub outlines how to fork a branch, keep it up to date with the source branch, and commit your own changes here: help.github.com/articles/fork-a-repo.
Specifically, you’ll create a Pull Request from your branch to the Torque 3D development branch. The Pull Request allows for a discussion of the proposed changes, and additional changes may be required before a Pull Request is accepted by the Steering Committee. You must ensure you have the full rights to the code you are submitting in order for us to include it in future updates.
What is the Steering Committee?
To maintain the open source Torque 3D master and development branches, a committee has been set up that has Write Access and may respond to Pull Requests. This Steering Committee is dedicated to making the best core version of Torque 3D so that others can build upon a reliable foundation. To that end, one of the first tasks of the committee is coming up with the T3D roadmap based on the community’s input.
As of today, the Steering Committee consists of the following GarageGames members:
However, we don’t believe that the Steering Committee should only come from GarageGames. Over time everyone but myself will be replaced by members of the community, and the committee will be allowed to grow as required. We have put together a draft of the Steering Committee’s Charter that outlines its roles and responsibilities:
If you would like to join us on the Steering Committee please write me an email at firstname.lastname@example.org and tell me about yourself. We’re not just looking for programmers on the committee. We would like to see people from all facets of game and game engine development on the Steering Committee. That will create the healthiest Torque 3D open source ecosystem.