Flume Community Scripts

A community-maintained collection of scripts for the Flume IRC client.

Browse and install scripts at scripts.flumeirc.io or directly from Flume:

/script search <keyword>
/script install <name>
/script update <name>

Repository Layout

scripts/
  python/
    <category>/
      <script-name>/
        <script-name>.py
        manifest.toml
        README.md
  lua/
    <category>/
      <script-name>/
        <script-name>.lua
        manifest.toml
        README.md

Submitting a Script

1. Fork this repo
2. Create a directory under scripts/<lang>/<category>/<your-script>/
3. Add your script file, a manifest.toml, and a README.md
4. Open a PR

Manifest Format

name = "xauth"
description = "Authenticate with Undernet's X services bot"
author = "your-nick"
version = "1.0.0"
language = "python"               # or "lua"
tags = ["auth", "undernet"]
flume_min = "1.2.5"               # minimum Flume version
dependencies = ["pyotp"]          # python pip packages or lua rocks
homepage = "https://example.com"  # optional

Guidelines

• Scripts must be self-contained and use only the flume API for IRC operations
• Keep secrets in the vault (flume.vault.get), never hardcode
• Include a setup section in the README
• Test your script before submitting
• Use clear, descriptive command names that won't conflict with built-ins

Categories

• auth — Authentication helpers (NickServ, X, Q, etc.)
• fun — Fun and games
• logging — Custom logging and exports
• moderation — Channel ops tools
• notifications — Custom notification handlers
• utility — General utilities

License

Each script is licensed by its author. Check the script's README for details. Contributions to the index/tooling are MIT.