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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

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