TGEA/CreatingYourFirstFPS/VersionControl/TortoiseSVN

From TDN

Contents

Quick Guide to SVN

Navigation

FPS Tutorial
RPG Tutorial
Setup
Version Control

For Windows

The following tutorial is a quick reference for installing an SVN code repository on your hard drive for local version control.

Overview

Image:tortoisesvn_logo.jpg
Trotise SVN integrates seemlesly with windows explorer. Take a look at the feature overview here

Help Files

Click here for the Help Files

Download

Download the tortise svn tool http://tortoisesvn.tigris.org/ [1]

Installation Guide

Click here for the tortoise SVN Installation Guide


Creating your own SVN Repository

SVN is a version control system. A version control system is where one or more developers check out code from a code repository, make modifications and commit changes back to the repository. The repository is created with an initial baseline code import. The code is then checked out to a working directory. Changes are made, updates applied and then the code is committed from the working directory back to the repository. A small diagram of the basic steps is provided below.

Image:Svn.cycle.jpg

Usually the repository is only imported once. As a developer ost of the time is spent with steps 3 and 4, Updating your working directory and committing your code changes.


Quick and Dirty: Setup the repository

We will cover only the quickest way to set up svn. The concept is for a single developer who wishes to safe guard his or her development efforts. This is not the proper way to set up SVN for team development, but it will give you the basic idea. I know this is not the recommended way (spare me the lecture). Its the easy way. Lets start by creating two directories:

C:/dev C:/svn_repository

Good. Now lets create a directory under C:/svn_repository called TGEA_1_7_1 (or whatever you Torque Engine is) it should look like this:

C:/svn_repository/TGEA_1_7_1

Right click the TGEA_1_7_1 folder and you will see the tortoise svn menu. Select create repository here as seen below. Use the native files system when prompted.


Image:Svn.engine.repository.jpg


Congrats! You just created your svn repository. Look at the files if you like.

Import TGEA engine source code

Now lets Import TGEA engine source code into your repository . Go to your torge engine installation directory and find the engine source code. Typically its in a directory like this: C:\Torque\TGEA_1_7_1\. The goal is to import the files into our local repository. Right click on the engine folder and select svn / import. You should see a dialog like the one below. It will ask you for the repository location. Type in: file:///C:/svn_repository/TGEA_1_7_1

Image:Svn.import.dir.jpg



file:///C:/svn_repository/TGEA_1_7_1
Image:Svn.import.jpg

Export the Source into your development directory

Now lets set up our development directory for the Torque game engine. We've imported the files into our own local repository, now we need to export them into our development directory so we can begin work. Go to our c:/dev directory and create our new TGEA_1_7_1 directory.

C:\dev\TGEA_1_7_1


Right mouse click the TGEA_1_7_1 directory and select svn / checkout. You should see a dialog similar to the following:


Image:Svn.checkout.jpg

Commit your changes

Now you are free to begin your work. As you modify them commit your changes and add comments. Just right click svn / commit. Viola! You are now editing modifying your own version of the torque game engine.


Image:Svn.commit.jpg