Skip to main content

A library for making a bot in Destiny.gg chat.

Project description

PyPI version info PyPI supported Python versions

A library for making a bot in Destiny.gg chat.

Installing

Python 3.9 or higher is required (version 0.5.0 and above, Python 3.8+ for versions below)

# Linux/macOS
python3 -m pip install -U dgg-bot

# Windows
py -3 -m pip install -U dgg-bot

Usage

Not sure what to put here at this point in time. Unauthorized chat bots are subject to being banned, ask Cake in DGG for permission and guidelines for chat bots before running one.

Examples

A simple bot with three commands and will yump back at chatters.

from dggbot import DGGBot
import time

bot = DGGBot(
    "AUTH_TOKEN",
    username="Username",
    owner="Owner",
    prefix="$",
    wss="wss://chat.omniliberal.dev/ws",
)  # default command prefix is "!"

@bot.command()
@bot.is_owner()  # only the owner named in DGGBot can use this command.
def test(msg):  # $test
    msg.reply("Test 123")

@bot.command(aliases=["banmeplease"])  # aliases for this command
def banme(msg):  # $banme / $banmeplease
    bot.send("RightToBearArmsLOL BINGQILIN nathanTiny2")


def is_cake(msg):  # a check where only the user Cake can use commands with this check
    return msg.nick == "Cake"

@bot.command(aliases=["oooo"])
@bot.check(is_cake)
def pog(msg):
    msg.reply("Cake OOOO")

"""
Events
You can either name the function after the event, or include the event name in the decorator.
mention() is also included as a shortcut for event("on_mention").

Event names: on_ban, on_broadcast, on_join, on_mention, on_msg, on_mute, on_privmsg, on_quit,
             on_refresh, on_unban
"""

@bot.event()
def on_msg(msg):
    print(msg)

# @bot.event("on_mention")
@bot.mention()
def yump(msg):
    if "MiyanoHype" in msg.data:
        time.sleep(0.5)
        msg.reply(f"{msg.nick} MiyanoHype")

if __name__ == "__main__":
    bot.run_forever()

Connecting to alternative DGG environments.

from dggbot import DGGBot
import time

bot = DGGBot(
    "AUTH_TOKEN",
    username="Username",
    owner="Owner",
    prefix="$",
    wss="wss://chat.omniliberal.dev/ws",
)

@bot.event()
def on_msg(msg):
    print(msg)

if __name__ == "__main__":
    while True:
        bot.run(origin="https://www.omniliberal.dev")
        time.sleep(2)

License

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

dgg-bot-0.7.0.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

dgg_bot-0.7.0-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

Details for the file dgg-bot-0.7.0.tar.gz.

File metadata

  • Download URL: dgg-bot-0.7.0.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.5

File hashes

Hashes for dgg-bot-0.7.0.tar.gz
Algorithm Hash digest
SHA256 bcc2668a0557448b5c23112b6bfc14b42a195c595f48b97a82868aefe98d4fbf
MD5 3c932f1bf1887436c5d265b95b706ce8
BLAKE2b-256 8d4761069f4a07a86b51d33dec7a969de20f71a6b0f8212fcd9b5efb215b12b8

See more details on using hashes here.

File details

Details for the file dgg_bot-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: dgg_bot-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 11.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.5

File hashes

Hashes for dgg_bot-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8ab916b69242f74b2767b37630be4d50152d65d99506ebf3ad9800a09e4dfcf7
MD5 98f183a68b7bc943705cda8ca0249987
BLAKE2b-256 b399d88539a24806643f4987f00cc6a0a2dc0e9bdb3b1efa1c724993efb9c57d

See more details on using hashes here.

Supported by

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