jklmbot

Win all of your JKLM.fun games!

Index

Index
Purpose
Getting Started
- Prerequisites
Installing
- From Git
Usage
Contributing
Built With
Authors
Licensing

Purpose

jklmbot is a simple script to let your computer play "BombParty" on the website jklm.fun

Warning

The code for this script hasn't been updated for a long time and might not work as well as back when the code was written! Please contribute and fix stuff if you spot any bug 🙇.

It could be used to train, or have a bit of fun.

Note

The script doesn't check for the other players' answers, so it's not a guarantee to win every game.

Warning

This is made public for entertainment and education purposes and should not be used to ruin any party online. It was meant to be used with private games and should stay in private games. You are the only one responsible for any misuse of this script.

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

You will need Python 3 to use this module

Minimum required versions: 3.8

Although the code itself is made compatible with Python >=3.6, the dependencies require at least Python 3.8.

Always check if your Python version works with jklmbot before using it in production.

Installing

From Git

pip install --upgrade git+https://github.com/Animenosekai/jklmbot.git

This will install the latest development version from the git repository

You can check if you successfully installed it by printing out its version:

$ jklmbot --version
1.0

Usage

Go create a "BombParty" room on jklm.fun and run the script using:

jklmbot --room="<YOUR_ROOM_ID>"

But there are lots of stuff to customize so head over to your terminal and enter:

🧃❯ jklmbot --help
usage: jklmbot [-h] [--version] --room ROOM [--username USERNAME] [--picture PICTURE] [--browser BROWSER] [--headless] [--delay DELAY] [--key KEY] [--check CHECK]

Win all of your JKLM.fun games!

options:
  -h, --help            show this help message and exit
  --version, -v         show program's version number and exit
  --room ROOM, -r ROOM  The room to enter.
  --username USERNAME, -u USERNAME
                        The username to use.
  --picture PICTURE, -p PICTURE
                        The profile picture to use.
  --browser BROWSER, -b BROWSER
                        The browser to use (chromium|firefox|webkit).
  --headless            Wether to run the browser without a graphical interface.
  --delay DELAY, --max-delay DELAY, -d DELAY
                        The maximum delay before searching for answers to avoid being caught (in secs).
  --key KEY, --key-delay KEY, --keystroke-delay KEY, --keyboard-delay KEY, --keypress-delay KEY, -k KEY
                        The delay between each keypress for the input to appear more realistic (in ms).
  --check CHECK, --check-delay CHECK, -c CHECK
                        The delay before checking if the answer is right or not (in secs).

Contributing

Pull requests are welcome. For major changes, please open a discussion first to discuss what you would like to change.

Built With

playwright - to control a web browser
The different dictionaries under jklmbot/data are coming from different sources

Authors

Animenosekai - Initial work - Animenosekai

Licensing

This software is licensed under the MIT License. See the LICENSE file for more information.

Animenosekai / jklmbot