Module Header Template (SSH)

From Adventure Game Studio | Wiki
Jump to: navigation, search

This is the template for a module header that SSH uses. There is no corresponding script template: all the information is contained in the header:

// Script header for module 'ModuleName'
//
// Author: My name (Forum nick)
//   Please use the PM function on the AGS forums to contact
//   me about problems with this module
// 
// Abstract: Brief description of the module
//
// Dependencies:
//
//   AGS version required
//   AGS setting required
//   Other modules, GUIs, characters, etc required
//
// Functions:
//   Describe the functions provided by the module
// 	 
// Configuration:
//   Describe the variables provided to configure the module
//
// Example:
// 
//   Example AGS script code of how to configure and use the module
//
// Caveats:
//   Any missing functionality, bugs, to-be-done stuff, etc.
//   
// Revision history:
//   version number, change date, short description of changes
//
// Licence:
//
//   ModuleName AGS script module
//   Copyright (C) 2005 My Name
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to 
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in 
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
// DEALINGS IN THE SOFTWARE.

// Defines

// Structure declarations

// Function imports

// Variable imports