Source Control: Difference between revisions

From Adventure Game Studio | Wiki
Jump to navigation Jump to search
(Created page with "The purpose of this page is to help you set up your game in a source control (a.k.a. version control or revision control) system. It is also intended for games created with AG...")
 
mNo edit summary
Line 40: Line 40:
* Adding new rooms can be tricky. Make sure that everyone knows you're adding a new room and commit it as soon as possible before you keep going.
* Adding new rooms can be tricky. Make sure that everyone knows you're adding a new room and commit it as soon as possible before you keep going.
* Don't have more than one person work on the same room or adding/changing sprites at the same time! Coordinate over chat!
* Don't have more than one person work on the same room or adding/changing sprites at the same time! Coordinate over chat!
[[Category:Advanced Tutorials]]

Revision as of 05:46, 9 April 2013

The purpose of this page is to help you set up your game in a source control (a.k.a. version control or revision control) system. It is also intended for games created with AGS 3.x. These are how to set up the game for source control with free tools such as Subversion, Git, Mercurial, etc. It does not involve using the Source control integration available in the AGS Editor settings.

What to add

The typical AGS game is structured in the following way:

   gamename\
       Compiled\
       Music\
       Sound\
       Speech\
       acsprset.spr
       backup_acsprset.spr
       Game.agf
       Game.agf.bak
       Game.agf.user
       sprindex.dat
       user.ico
       (fonts [.ttf and .wfn])
       (script headers [.ash] and source [.asc])
       (room files [.crm] and script [.asc])

You want to add all of the files, including keeping the folder intact. AGS will make your game's exe based on the folder name.

For example, if you're using Subversion, and your game is called "adventure", then with the standard convention you want to check it out under under something like: yourserver/adventure/trunk/adventure. You can use of the rest of the trunk to keep changes on your source images, audio, etc.

You should not add these to source control:

  • The Compiled folder - Just contains the build of your game
  • backup_acsprset.spr - It's just a backup of your sprites, typically gets generated by the AGS editor.
  • Game.agf.bak - It's just another backup file. Will be generated by the AGS Editor.

If you're using Subversion, you can add these files to your .svnignore file.

Rules when making changes

Please keep in mind that these are good rules when working with other people:

  • Make sure you get the latest changes from the server before you start working.
  • When adding sprites, make sure to lock acsprset.spr and sprindex.dat which is where your sprites are being saved,
  • Adding new rooms can be tricky. Make sure that everyone knows you're adding a new room and commit it as soon as possible before you keep going.
  • Don't have more than one person work on the same room or adding/changing sprites at the same time! Coordinate over chat!