1. This site uses cookies. By continuing to use this site, you are agreeing to our use of cookies. Learn More.

Template for Plugin Description

Discussion in 'Plugins' started by Nick, Jul 18, 2009.

  1. Nick

    Nick Well-Known Member

    Plugin Name
    Version:
    Author:
    Created on: YYYY/MM/DD
    Last Updated:
    YYYY/MM/DD
    Tested on: (Hotaru version)
    Plugins Required: ... / None
    Plug & Play: Yes / No - Needs (template / plugin / database / core file) edits.
    Supported: No / Yes

    Description
    Enter description here.

    Instructions
    Enter instructions here.

    Revision History
    Version YYYY/MM/DD - Brief description of changes.

    Please click "Rate Thread" and give this plugin a rating. Thank you.
     
    Last edited by a moderator: Mar 27, 2010
    davidshq likes this.
  2. Nick

    Nick Well-Known Member

    I think the above template is pretty self-explanatory, but let me give some examples:

    Tested on:

    Example: Tested on: Hotaru Alpha, Beta 0.6, etc.

    Plugins Required:

    Example:
    Plugins Required: Users 0.1, Submit 0.2

    Plug & Play:

    This quickly tells a user what they need to do to get the plugin working.

    Example: Plug & Play: No - Needs template edits.

    Supported:

    This indicates to users whether support is available for the plugin. Some developers may just want to share their plugin, but don't have the time or desire to offer support. If that's the case then it should be marked "No". If the developer can respond to comments posted in the thread, it should be marked "Yes".

    Example: Supported: Yes

    Note: It's not compulsory you use the template, but it should make posting a plugin simpler and provide users with the most useful info.
     
    davidshq likes this.

Share This Page