Difference between revisions of "PlugIn Development:GameEx PlugIn Info"
Jump to navigation
Jump to search
| (18 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
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.<br />< | 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.<br /> | ||
<div class="note_block_red"><b>PLEASE NOTE:</b> ''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).<br />Also, as of version 1.41, only <span class="plugin_return_text">PlugInType.Emulator</span> is supported by the application.''</div><br /> | |||
== <span | == <span class="plugin_headline_text">Variables</span> == | ||
<p>Below is a reference of the <span style="color:darkred">< | <p>Below is a reference of the variables> available in this structure:</p> | ||
< | <div class="code_variables"> | ||
<table> | |||
<th><span style="color:darkred">Variable</span></th><th style="text-align:center;"><span style="color:blue;">[Value]</span></th><th>Description</th> | |||
<tr><td><span style="color:darkred">Name</span></td><td style="text-align:center;"><span style="color:blue">[string]</span></td><td>The name of your plugin as it will appear in the PlugIn Manager.</td></tr> | |||
<tr><td><span style="color:darkred">Version</span></td><td style="text-align:center;"><span style="color:blue">[string]</span></td><td>The build number of your plugin as it will appear in the PlugIn Manager.</td></tr> | |||
<tr><td><span style="color:darkred">Author</span></td><td style="text-align:center;"><span style="color:blue">[string]</span></td><td>Your name as it will appear in the PlugIn Manager.</td></tr> | |||
<tr><td><span style="color:darkred">Description</span></td><td style="text-align:center;"><span style="color:blue">[string]</span></td><td>A brief description of your plugin as it will appear in the PlugIn Manager.</td></tr> | |||
<tr><td valign="top"><span style="color:darkred">PlugInType</span></td><td valign="top" style="text-align:center;"><span style="color:blue">[PlugInType]</span></td><td>The type of plugin you are creating.<br /><span style="color:darkred"><b>•NOTE•</b> Only PlugInType.Emulator is supported at this time!</span></td></tr> | |||
<tr><td valign="top"><span style="color:darkred">PlugInVersion</span></td><td valign="top" style="text-align:center;"><span style="color:blue">[string]</span></td><td>The version of the PlugIn framework you are targeting.<br /><span style="color:darkred"><b>•NOTE•</b> 1.40 is intended for legacy mode only! Use 1.41 instead!</span></td></tr> | |||
</table></div> | |||
<br /> | |||
== <span | == <span class="plugin_headline_text">Structures</span> == | ||
=== <span | === <span class="plugin_text_fx">VB.NET</span> === | ||
<pre | <pre class="code_es_vb"> | ||
Public Structure PluginInfo | Public Structure PluginInfo | ||
Public Const Name As String = "My Cool Plugin" | Public Const Name As String = "My Cool Plugin" | ||
| Line 18: | Line 29: | ||
End Structure</pre> | End Structure</pre> | ||
=== <span | === <span class="plugin_text_fx">C#</span> === | ||
<pre | <pre class="code_es_cs"> | ||
public struct PluginInfo | public struct PluginInfo | ||
{ | { | ||
Latest revision as of 20:19, 30 April 2014
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.
Also, as of version 1.41, only PlugInType.Emulator is supported by the application.
Variables
Below is a reference of the variables> available in this structure:
| Variable | [Value] | Description |
|---|---|---|
| Name | [string] | The name of your plugin as it will appear in the PlugIn Manager. |
| Version | [string] | The build number 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 brief description of your plugin as it will appear in the PlugIn Manager. |
| PlugInType | [PlugInType] | 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 instead! |
Structures
VB.NET
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#
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";
}