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

Uploaded Source

Built Distribution

dgg_bot-0.8.0-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dgg-bot-0.8.0.tar.gz
  • Upload date:
  • Size: 9.3 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.8.0.tar.gz
Algorithm Hash digest
SHA256 9f19a93a1726302a74fbd7250e1756960c829794fdb17764989764398d57ba41
MD5 13879256c24884d1189a02aef0d6bdbb
BLAKE2b-256 46f7b35f8cbb15f91cb7baa1800d5bad5ee8fa4f64aabae36e9f2362e3bb3804

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dgg_bot-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 11.6 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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fcf1292f0659eb73edc209f8e32255ab47e0e4c1d828ca17deb805157e55c4f9
MD5 26733705887568e4de2bc84157505979
BLAKE2b-256 693d1274f93390dc39eec6601d272a92308cf7be0be47370741eebc5e49aa088

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