STEAMp3 - SDK
Home
Features
Download
Commands
Skins
Plug-ins
Stats
SDK
Help
Credits
STEAMp3 Development Kit (SDK)
If you are thinking about writing plug-ins for STEAMp3, you've come to the right place!
Introduction
The STEAMp3 Developlemt Kit (SDK) allows Microsoft Visual C# developers to create a wide variety of plug-ins for STEAMp3. Harness the power of the rich STEAMp3 UI platform and Open Steamworks API with just a few lines of code!
The SDK gives you complete access to the STEAMp3 media player, commands, skins, and UI classes directly using managed code, no p/invoke required! From simple utilities to robust, fully featured applications, creating custom plug-ins for STEAMp3 is easy with this SDK. All it takes is a text editor and a basic knowledge of C# and the .NET Framework.
HelloWorld plug-in
The HelloWorld plug-in is included with the SDK and contains the general building blocks required for creating a STEAMp3 plug-in. The HelloWorld.cs source file is located in the SDK\Samples folder.
// Imported namespaces
using System.Reflection;
using Steamp3.Plugins;
using Steamp3.UI;

// Assembly information
[assembly: AssemblyProduct("HelloWorld")]
[assembly: AssemblyCompany("Ta0soft")]
[assembly: AssemblyDescription("Hello world plug-in (SDK Sample 01)")]
[assembly: AssemblyCopyright("Copyright © 2013 Ta0 Software")]
[assembly: AssemblyVersion("1.0")]

// Main class must inherit the Steamp3.Plugins.IPlugin interface.
// The Plugin class provides access to STEAMp3 without the use of UI elements.
// This class will be automatically disposed when the constructor exits the scope.
public class HelloWorld : Plugin
{
    // Constructor AKA entry point of the plug-in (Required).
    public HelloWorld()
    {
        // Create a Steamp3.UI.InfoDialog and display it to the user.
        InfoDialog info = new InfoDialog("Hello world!");
        info.ShowDialog();
    }
}
Plug-in Guidelines
1. Plug-ins can be composed of a single file with only one class, or multiple files made up of many classes working together, but must contain only one Main class.
2. The Main class must inherit the Steamp3.Plugins.IPlugin interface for STEAMp3 to recognize the assembly as a valid plug-in.
3. The Main class must be declared public, and contain only one parameterless constructor used as the entry point of the plug-in.
4. All plug-ins must contain assembly information using the attributes within the System.Reflection namespace.
5. Plug-ins are restricted to the following System namespaces for end-user security purposes:
Table of Contents
Start here if you are interested in writing plug-ins for STEAMp3.
Global classes are static (shared) objects that provide helper functions used throughout STEAMp3 in many different situations.
Instance classes allow you to create controls such as Windows, Buttons, Dropdowns, Lists, and more using object-oriented code.
Create custom commands using the OnMessageReceived events.
Gather real-time information about skins, updates, user stats, achievements, and more using Extensible Markup Language (XML) format.
6. Help
Common questions reguarding the STEAMp3 Development Kit (SDK).
 
Skin: Steam Author: Valve Created: 10/04/2011 The Steamworks API is Copyright © 2014 Valve Corporation.
Copyright © 2014 Ta0 Software. All rights reserved. All trademarks are property of their respective owners in the US and other countries.