Installation

Installation

This page explains how to install OpenLuaTools as a Millennium plugin for OpenSteamTool.

Requirements

Before installing OpenLuaTools, you need:

• Steam installed.
• OpenSteamTool installed and working.
• Millennium installed and working.
• A current OpenLuaTools release package or a local clone of this repository.

OpenLuaTools is a Millennium plugin, so the extracted plugin folder must contain the expected Millennium plugin files, including:

plugin.json
backend/
public/

Recommended install method

1. Download the latest OpenLuaTools release from the repository's Releases page.
2. Extract the release archive.
3. Place the extracted OpenLuaTools folder in your Millennium plugins directory.
4. Restart Steam.
5. Open the Millennium settings menu.
6. Go to Plugins.
7. Enable OpenLuaTools.
8. Save changes and restart Steam again if Millennium asks you to.

Manual install from source

Use this if you are testing changes or working on the plugin.

git clone https://github.com/ToxcGang/OpenSteamToolPlugin.git

Then place the repository folder, or a symbolic link to it, in the Millennium plugins directory.

The plugin root should look like this:

OpenSteamToolPlugin/
├─ plugin.json
├─ backend/
├─ public/
├─ scripts/
├─ CHANGELOG.md
└─ readme.md

Updating

1. Download the newest release or pull the newest source changes.
2. Replace the old plugin files.
3. Restart Steam.
4. Open Millennium settings and confirm OpenLuaTools is still enabled.

Where OpenLuaTools stores OpenSteamTool Lua scripts

OpenLuaTools is OpenSteamTool-only. It uses:

<Steam>/config/lua

It does not write to the old SteamTools path:

<Steam>/config/stplug-in

Migrating from legacy SteamTools LuaTools

Automatic migration is not performed.

If you previously used a SteamTools version, review your old files manually before moving anything. Only move files you understand. OpenSteamTool expects Lua scripts in <Steam>/config/lua.

Verify installation

After Steam restarts, check that:

• OpenLuaTools appears in Millennium's plugin list.
• The OpenLuaTools button/icon appears in the Steam UI.
• No missing-file errors appear in the Millennium or plugin logs.
• <Steam>/steamui/webkit/openluatools.js and related webkit assets are copied by the plugin when it loads.