Skip to main content

Ready-made plugins for nerimity-sdk bots

Project description

nerimity-sdk-contrib

Ready-made plugins for nerimity-sdk bots.

pip install nerimity-sdk-contrib

Plugins

Plugin Description
WelcomePlugin Greets new members with a configurable message
AutoModPlugin Deletes messages matching a word/regex list
StarboardPlugin Reposts highly-reacted messages to a starboard channel
LoggingPlugin Logs joins, leaves, deletes, and edits to a channel

Usage

from nerimity_sdk import Bot
from nerimity_sdk_contrib import WelcomePlugin, AutoModPlugin, StarboardPlugin, LoggingPlugin, RoleMenuPlugin, PollPlugin

bot = Bot(token="...", prefix="!")

@bot.on("ready")
async def on_ready(me):
    await bot.plugins.load(WelcomePlugin(channel_id="123"))
    await bot.plugins.load(AutoModPlugin(blocked=["badword"], log_channel_id="456"))
    await bot.plugins.load(StarboardPlugin(channel_id="789", threshold=3))
    await bot.plugins.load(LoggingPlugin(channel_id="000"))

bot.run()

Adding a new plugin

  1. Create nerimity_sdk_contrib/your_plugin.py with a class inheriting PluginBase
  2. Import and re-export it in __init__.py
  3. Add it to the table above and to the plugin marketplace docs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nerimity_sdk_contrib-1.1.0.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nerimity_sdk_contrib-1.1.0-py3-none-any.whl (1.5 kB view details)

Uploaded Python 3

File details

Details for the file nerimity_sdk_contrib-1.1.0.tar.gz.

File metadata

  • Download URL: nerimity_sdk_contrib-1.1.0.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for nerimity_sdk_contrib-1.1.0.tar.gz
Algorithm Hash digest
SHA256 1da99ebc5f83b2b59fa9ac914b889ac52ee4d7b2aad454e65e1e6ad01dd1d4a7
MD5 354fa01d3a45e9c81483c7e0a6802768
BLAKE2b-256 b6b259043eced7ab59aa4128708ac9cf3f4afd05e3dc0b159a77be98c3aeeb0c

See more details on using hashes here.

File details

Details for the file nerimity_sdk_contrib-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for nerimity_sdk_contrib-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 392b71b78538f7fe4a6f9fd8d3a9f5f4e2297dee36e5fbbe6ec659186482fbc9
MD5 2fccb3cdd02b5001701a4177b114099e
BLAKE2b-256 3977c51f3d255886479e3c2d3ea722ae9fa3bd9c24ea9b3f3cc4e745b0e731df

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page