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__":
    while True:
        bot.run()
        time.sleep(2)

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.6.0.tar.gz (8.6 kB view details)

Uploaded Source

Built Distribution

dgg_bot-0.6.0-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dgg-bot-0.6.0.tar.gz
  • Upload date:
  • Size: 8.6 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.6.0.tar.gz
Algorithm Hash digest
SHA256 1281bdb4c4200b009cf2942938f7bfadd0edf9cd5adc48a7703e9037854b1269
MD5 081824a2668184e1a4d227b6c83c534f
BLAKE2b-256 728d848f3197fd0ff54cdfb2a98f6e48f7029e0ac2da9708c99b660e72b8565e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dgg_bot-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 11.0 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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 35b2f61ecf77d1ca6beda562cbca148456919b7a363ae48f2f795e2ea6ee31ba
MD5 e4a99f7db29ddc39950db267cf3c749c
BLAKE2b-256 b050099b2e36a3e5b8c59cb21b4a3067863167fbd2e8d2e0de14ca29fc08f380

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