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",
    owner="Owner",
    prefix="$",
)  # 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(
    owner="Owner",
    prefix="$",
    wss="wss://chat.omniliberal.dev/ws",
    sid="SID",
    rememberme="REMEMBERME",
)

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

if __name__ == "__main__":
     bot.run_forever(origin="https://www.omniliberal.dev")

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

Uploaded Source

Built Distribution

dgg_bot-0.9.0-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dgg-bot-0.9.0.tar.gz
  • Upload date:
  • Size: 9.7 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.9.0.tar.gz
Algorithm Hash digest
SHA256 6faa89cb813e9a1f2edefc0a38687111e9151d897b6316402f52afc0f10a51d6
MD5 bea69acf7d7bafd1556fa1d74a26aee0
BLAKE2b-256 3092d6ff8b5921a8ba2d24c26824a056ae7fa10027663bd7d0170a8077bb5392

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dgg_bot-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 12.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.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4f0387ba6d1577f9942fe5c4afcad4a4acf161f11f5e2d17c48be2184b8ce7ee
MD5 141ff06d12a530eedff34ea7b1795c95
BLAKE2b-256 a630c768760c969e8bf6e62311080df554a08c0e9ce2a655a082ab41ec243a41

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