Skip to main content

A Python wrapper for the MafiaGG API

Project description

MafiaggBot

Usage


git clone https://github.com/blacksmithop/MafiaggBot

cd MafiaggBot

Installation

Install dependencies

python3 -m pip install -r requirements.txt

Create a .env file with credentials

MAFIA_USERNAME=username
MAFIA_PASSWORD=password

Running the bot

python3 runbot.py

Note: When you run the bot for the first time, it will download the deck and setup data and store it in bot/data/ folder.

Features

  • Rooms
    • List rooms
    • Make private/public
    • Become player/spectator
    • Do afk check
      • Do afk check
      • Do ready check
    • Rename room
    • Create new room
      • Only create room when game end
  • Decks
    • Get deck by name
    • Set deck by name
    • Use random deck
  • Setups
    • Get setup by name
    • Set setup by code
    • Set setup by name
    • Get current setup code
  • Roles
    • Get role by name
    • Cleanup role descriptions with validator
  • Commands
    • Custom command names
    • Command docs
  • Bot Client
  • Authentication
  • Help command
    • Formatted / multi-message help command
  • Host only commands

Tasklist

  • Don't create new room unless game end
  • Understand role object -> setup code creation
  • Return character info (for decks in next message)
  • Better commands (sub-commands!)
  • Better doc strings using decorators
  • When exiting bot site calls DELETE on user-session (cookie invalidation?)
  • Join other rooms on request
  • Allow for super().__init__ calls

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

mafiagg-1.0.0.tar.gz (79.3 kB view details)

Uploaded Source

Built Distribution

mafiagg-1.0.0-py3-none-any.whl (83.8 kB view details)

Uploaded Python 3

File details

Details for the file mafiagg-1.0.0.tar.gz.

File metadata

  • Download URL: mafiagg-1.0.0.tar.gz
  • Upload date:
  • Size: 79.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for mafiagg-1.0.0.tar.gz
Algorithm Hash digest
SHA256 b4a9896e044e6cf07d88750d2bdf44fefcf5cff9d3a4fc248e4ac7f27c511520
MD5 0796669badbcde4719f7112721f6308e
BLAKE2b-256 f9d5a41a476aad12d7629fcff97cb7a2da092dbb0106f9abfffb048f09c68b50

See more details on using hashes here.

File details

Details for the file mafiagg-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: mafiagg-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 83.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for mafiagg-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ed6a552c3eb443e7a9b06f1c54ff27d1dcff7789855493f676c9c69c194a4ed4
MD5 b1e661ee288a7e21710fb839d724afbd
BLAKE2b-256 6ccb3fbca904b719a8a065ae2f1dde93e90010ed8b5357ffd5dede27a299feef

See more details on using hashes here.

Supported by

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