1# Adventure Game Studio 2 3Adventure Game Studio (AGS) - is the IDE and the engine meant for creating and running videogames of adventure (aka "quest") genre. It has potential, although limited, support for other genres as well. 4 5Originally created by Chris Jones back in 1999, AGS was opensourced in 2011 and since continued to be developed by contributors. 6 7An official homepage of AGS is: http://www.adventuregamestudio.co.uk 8 9Both Editor and Engine are licensed under the Artistic License 2.0; for more details see [License.txt](License.txt). 10 11 12## Engine instructions 13 14To get started building the AGS engine, see the platform specific instructions or forum threads: 15 16- [Linux](debian/README.md) ([Forum thread](http://www.adventuregamestudio.co.uk/forums/index.php?topic=46152.0)) 17- [Windows](Windows/README.md) ([Forum thread](http://www.adventuregamestudio.co.uk/forums/index.php?topic=46847.0)) ([wiki](http://www.adventuregamestudio.co.uk/wiki/Compiling_AGS)) 18- [Android](Android/README.md) ([Forum thread](http://www.adventuregamestudio.co.uk/forums/index.php?topic=44768.0)) 19- [iOS](iOS/README.md) ([Forum thread](http://www.adventuregamestudio.co.uk/forums/index.php?topic=46040.0)) 20- [PSP](PSP/README.md) ([Forum thread](http://www.adventuregamestudio.co.uk/forums/index.php?topic=43998.0)) 21- [Mac OS X](OSX/README.md) ([Forum thread](http://www.adventuregamestudio.co.uk/forums/index.php?topic=47264.0)) 22 23When running the engine on you may configure it by modifying acsetup.cfg or using several command line arguments. 24On Windows you may also invoke a setup dialog by running executable with "--setup" argument, or executing winsetup.exe, if it is present. 25For the list of available config options and command line arguments, please refer to [OPTIONS.md](OPTIONS.md). 26 27 28## Issue tracker 29 30Please report bugs and feature requests at the [AGS Issue Tracker](http://www.adventuregamestudio.co.uk/forums/index.php?action=projects)! 31 32 33## Contributing 34 35We welcome any contributor who wishes to help the project. 36 37The usual workflow is this: you fork our repository (unless you already did that), create a feauture/fix branch, commit your changes to that branch, and then create a pull request. We will review your commits, and sometimes may ask to change something before merging into ours. 38 39For bug fixing and general code improvements that may be enough, however, for significant changes, especially completely new features, it is advised to first open an issue in the tracker and discuss it with development team, to make sure it does not break anything, nor contradict to existing program behavior or concepts. 40 41The [master](https://github.com/adventuregamestudio/ags/tree/master) branch should be kept in a working state and always compilable on all targeted platforms. 42Larger changes that potentially break things temporarily should first be made in other branches or in personal forks. 43 44We have a coding convention, please check it before writing the code: http://www.adventuregamestudio.co.uk/wiki/AGS_Engine_Coding_Conventions 45 46 47## AGS game compatibility: 48 49This runtime engine port is not compatible with all AGS games. There are the 50following restrictions: 51 52- Supported AGS versions right now are all starting from 2.50; games between 2.5 and 53 3.2 are supported in theory, but may have yet unknown compatibility issues. 54 You can check the version of AGS a game was made with by examining the properties 55 of the game executable. 56 If you try to run a game made with a newer or older version of AGS, you will 57 receive an error when trying to launch the game. 58- Savegames are compatible between the different platforms if they are created 59 with the same engine version. 60- Games that depend on plugins for which there is no platform-independent 61 replacement will not load. 62 63 64## Changes from Chris Jones' version of AGS 65 66This version of AGS contains changes from the version published by Chris Jones. 67The run-time engine was ported to Android, iOS, Linux, Mac OS X and PSP and a refactoring effort is under way. 68A detailed documentation of the changes is provided in the form of the git log of this git repository 69(https://github.com/adventuregamestudio/ags). 70 71 72## Credits 73 74[Link](Credits.txt) 75