Skip to content

Command-line tool for automating the rolling sequence for the Mudae Discord bot.

License

Notifications You must be signed in to change notification settings

vinlin24/waifu-roller

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Python Version

Coder's Waifu Roller

Command line tool for rolling anime/game characters with the Discord bot Mudae.

⚠️ This codebase has been deprecated. I found a much better way to do the same thing using AutoHotKey (AHK). The script is shared at scripts/mudae.ahk.

Description

Suppose you're in the zone coding, but it's a new hour and you can roll for waifus again. Before you'd switch to Discord, find the channel, and brainlessly spam enter $wa or something. Now you can start the whole rolling sequence right from the command line.

📣 No asking for user tokens, no Discord self-botting, no automatic claiming or sniping. This project uses PyAutoGUI to automate the process of switching to the app, navigating to the channel, and entering commands. This silly script is intended to just free up your hands a little while you watch the rolls go by.

Installation

With Python 3.10+

Download the desired wheel file waifu_roller-x.y.z-py3-none-any.whl from the dist folder or the Releases section and install it with pip:

pip install path/to/waifu_roller-x.y.z-py3-none-any.whl

You can verify that it's installed by running:

pip show waifu-roller

Usage

The CLI command is waifu:

waifu wa -c waifu-spam -n 10 -d

This example rolls the Mudae command $wa 10 times in the channel named waifu-spam. The optional -d flag appends the daily commands $dk and $daily after the rolling session.

You can also omit arguments and opt to use the default values set in the config.yaml file. This could be useful if you roll most commonly in a specific channel on a specific server:

waifu

This program supports hotkeys to assist your competitive waifu snatching. You can pause and resume rolling with CAPSLOCK to claim a character/kakera/whatnot, or abort altogether with ESC.

As usual, use the help flag for a full list of arguments, or use the config flag to get the full path to your configuration file:

waifu --help
waifu --config

Demos

Here's an example of using the command-line arguments. As a bonus, I got to showcase the CAPSLOCK pausing feature that allowed me to claim that kakera:

waifu-roller-args-demo.mp4

Here's an example of updating the config YAML file and running with default values:

waifu-roller-config-demo.mp4

Notice that in both videos I was not manually entering $wa to the text box. The key-sending is entirely automated, including switching to the Discord app and typing into the Quick Switcher.

References and Configuration

See REFERENCE.md.

Development

If you would like to contribute, please see DEVELOPMENT.md.

Change Log

See CHANGELOG.md.