Difference between revisions of "PlugIn Development:GameEx PlugIn Info"

From Spesoft/GameEx Wiki
Jump to navigation Jump to search
Line 3: Line 3:


==<span style="font-size:125%; color:darkblue;">Variable Details</span>==
==<span style="font-size:125%; color:darkblue;">Variable Details</span>==
<p>Below is a reference of the variable <span style="color:darkred"><b>name</b></span> and <span style="color:blue"><b>[type]</b></span> available in this structure:</p>
<p>Below is a reference of the <span style="color:darkred"><b>Variable Name</b></span> and <span style="color:blue"><b>[Data Type]</b></span> available in this structure:</p>
<div style="border-style:solid; border-color:darkred; background-color:#FFCCCC; border-width:2px; padding-left:5px; padding-right:5px; padding-top:5px; padding-bottom:5px;"><span style="color:darkred"><b>Name</b></span> <span style="color:blue"><b>[string]</b></span> : The name of your plugin as it will appear in the PlugIn Manager.<br /><span style="color:darkred"><b>Version</b></span> <span style="color:blue"><b>[string]</b></span> : The version of your plugin as it will appear in the PlugIn Manager.<br /><span style="color:darkred"><b>Author</b></span> <span style="color:blue"><b>[string]</b></span> : Your name as it will appear in the PlugIn Manager.<br /><span style="color:darkred"><b>Description</b></span> <span style="color:blue"><b>[string]</b></span> : A breif description of the plugin as it will appear in the PlugIn Manager.<br /><span style="color:darkred"><b>PlugInType</b></span> <span style="color:blue"><b>[Plugin_Type]</b></span> : The type of plugin you are creating.  <span style="color:darkred"><b>&bull;NOTE&bull;</b> Only PlugInType.Emulator is supported at this time!</span><br /><span style="color:darkred"><b>PlugInVersion</b></span> <span style="color:blue"><b>[string]</b></span> : The version of the PlugIn Framework you are targeting.  <span style="color:darkred"><b>&bull;NOTE&bull;</b> 1.40 is intended for legacy mode only! Use 1.41 to gain access to all available variables!</span></div><br />
<div style="border-style:solid; border-color:darkred; background-color:#FFCCCC; border-width:2px; padding-left:5px; padding-right:5px; padding-top:5px; padding-bottom:5px;"><span style="color:darkred"><b>Name</b></span> <span style="color:blue"><b>[string]</b></span> : The name of your plugin as it will appear in the PlugIn Manager.<br /><span style="color:darkred"><b>Version</b></span> <span style="color:blue"><b>[string]</b></span> : The version of your plugin as it will appear in the PlugIn Manager.<br /><span style="color:darkred"><b>Author</b></span> <span style="color:blue"><b>[string]</b></span> : Your name as it will appear in the PlugIn Manager.<br /><span style="color:darkred"><b>Description</b></span> <span style="color:blue"><b>[string]</b></span> : A breif description of the plugin as it will appear in the PlugIn Manager.<br /><span style="color:darkred"><b>PlugInType</b></span> <span style="color:blue"><b>[Plugin_Type]</b></span> : The type of plugin you are creating.  <span style="color:darkred"><b>&bull;NOTE&bull;</b> Only PlugInType.Emulator is supported at this time!</span><br /><span style="color:darkred"><b>PlugInVersion</b></span> <span style="color:blue"><b>[string]</b></span> : The version of the PlugIn Framework you are targeting.  <span style="color:darkred"><b>&bull;NOTE&bull;</b> 1.40 is intended for legacy mode only! Use 1.41 to gain access to all available variables!</span></div><br />



Revision as of 00:02, 27 April 2014

GameEx: PlugIn Info Overview

You would set your PlugIn variables here, and they will be exposed to GameEx. You can set the version number of your plugin, author name, app name, and many other variables.

PLEASE NOTE: Although you can change the PluginVersion to 1.40, you will lose a few variables. The 1.40 is only for legacy, and should not be used (stick with 1.41).
Also, as of version 1.41, only PlugInType.Emulator is supported by the application.

Variable Details

Below is a reference of the Variable Name and [Data Type] available in this structure:

Name [string] : The name of your plugin as it will appear in the PlugIn Manager.
Version [string] : The version of your plugin as it will appear in the PlugIn Manager.
Author [string] : Your name as it will appear in the PlugIn Manager.
Description [string] : A breif description of the plugin as it will appear in the PlugIn Manager.
PlugInType [Plugin_Type] : The type of plugin you are creating. •NOTE• Only PlugInType.Emulator is supported at this time!
PlugInVersion [string] : The version of the PlugIn Framework you are targeting. •NOTE• 1.40 is intended for legacy mode only! Use 1.41 to gain access to all available variables!


Code Examples

VB.NET syntax:

Public Structure PluginInfo
    Public Const Name As String = "My Cool Plugin"
    Public Const Version As String = "1.0.0"
    Public Const Author As String = "Adultery"
    Public Const Description As String = "Does some cool stuff to GameEx!"
    Public Const PluginType As Plugin_Type = Plugin_Type.Emulator
    Public Const PluginVersion As String = "1.41"
End Structure

C# syntax:

public struct PluginInfo
{
     public const string Name = "My Cool Plugin";
     public const string Version = "1.0.0";
     public const string Author = "Adultery";
     public const string Description = "Does some cool stuff to GameEx!";
     public const Plugin_Type PluginType = Plugin_Type.Emulator;
     public const string PluginVersion = "1.41";
}