Adventure Game Studio | Forums

AGS Support => Modules & Plugins => Topic started by: Dualnames on 02 May 2012, 16:31

Title: BOARD RULES! READ BEFORE POSTING! (MISSING WORKING LINK FOR A MODULE?)
Post by: Dualnames on 02 May 2012, 16:31

RULES

DO'S


DONT'S

CREATING A NEW TOPIC

Example:  MODULE: Tween v1.5 RC 1 - A programming module


PUBLISHING
- Download should include at least the .scm module file & documentation if it's a module, and the .dll plugin file & documentation if it's a plugin.
- A demo game is optional, though strongly encouraged.
- Zip/Rar format is preferred
- State which version of AGS it was written for
- Finally, add your module to the list of script modules (http://www.adventuregamestudio.co.uk/wiki/Module_IndexCategory) in the AGS Wiki. If it's a plugin, add it to list of plugins (http://www.adventuregamestudio.co.uk/wiki/List_of_plugins).


DOCUMENTATION
- Plain text (*.txt) or html file for maximum compatibility
- Same name as module/plugin
- Should contain the following:
  - Module/Plugin name
  - Module/Plugin version
  - Authors
  - Description of what module/plugin does and what it can be used for
  - Dependencies on other modules / plugins / AGS versions
  - List of all public functions and variables and how/where they are used
  - Revision history / Changelog with date
  - License: Free for non-commercial AND commercial use? Credit required or optional?
    We suggest the MIT license (http://www.opensource.org/licenses/mit-license.php):
Quote
/ 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.


Useful Links
Title: Re: BOARD RULES! READ BEFORE POSTING! (MISSING WORKING LINK FOR A MODULE?)
Post by: Dualnames on 30 Nov 2014, 22:23
Replied to put this on the top.