Caution

This plugin example and other related documentation is not yet finished. You will not receive support for development until everything is ready. This plugin template may not be fully functional, and critical portions of it may be outdated. Once this example is ready, this message will be removed

Plugin Template

A plugin template for Millennium providing a basic boilerplate to help get started. You'll need a decent understanding in python, and typescript (superset of javascript)

Prerequisites

• Millennium

Setting up

git clone https://github.com/SteamClientHomebrew/PluginTemplate
cd PluginTemplate

Building

pnpm run dev

Then ensure your plugin template is in your plugins folder. %MILLENNIUM_PATH%/plugins/plugin_template, and select it from the "Plugins" tab within Steam.

If you wish to develop your plugin outside of %MILLENNIUM_PATH%/plugins, you can create a symbolic link from your development path to the plugins path

Note:

MILLENNIUM_PATH =

• Steam Path (ex: C:\Program Files (x86)\Steam) (Windows)
• ~/.local/share/millennium (Unix)

Next Steps

https://docs.steambrew.app/developers/plugins/learn