https://github.com/MahjongRepository/tenhou-python-bot

Bot for tenhou.net riichi mahjong server written in Python
https://github.com/MahjongRepository/tenhou-python-bot

bot mahjong mahjong-bot python tenhou

Last synced: 3 months ago
JSON representation

Bot for tenhou.net riichi mahjong server written in Python

• Host: GitHub
• URL: https://github.com/MahjongRepository/tenhou-python-bot
• Owner: MahjongRepository
• License: mit
• Archived: true
• Created: 2016-04-17T15:54:58.000Z (over 8 years ago)
• Default Branch: dev
• Last Pushed: 2023-07-08T10:11:51.000Z (over 1 year ago)
• Last Synced: 2024-04-22T04:26:49.129Z (7 months ago)
• Topics: bot, mahjong, mahjong-bot, python, tenhou
• Language: Python
• Homepage:
• Size: 34.5 MB
• Stars: 200
• Watchers: 23
• Forks: 52
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![Build](https://github.com/MahjongRepository/tenhou-python-bot/workflows/Mahjong%20bot/badge.svg) [[Tests coverage]](http://mahjongrepository.github.io/tenhou-python-bot/)

The project is not maintained anymore, and exists primary for historical reasons and references.

Bot was tested with Python 3.7+ and PyPy3, we are not supporting Python 2.

# What do we have here?

![Example of bot game](https://cloud.githubusercontent.com/assets/475367/25059936/31b33ac2-21c3-11e7-8cb2-de33d7ba96cb.gif)

## Mahjong hands calculation

You can find it here: https://github.com/MahjongRepository/mahjong

## Mahjong bot

For research purposes we built a simple bot to play riichi mahjong. It can be run locally.

# For developers

## How to run it?

1. `pip install -r requirements/lint.txt`

1. Run `cd project && python main.py` it will connect to the tenhou.net and will play a game.

## How to run bot battle with pypy

To make it easier run bot vs bot battles we prepared PyPy3 Docker container.

Run the game locally:

1. [Install Docker](https://docs.docker.com/get-docker/) 

1. Run `make build_docker`

1. Run `make GAMES=1 run_battle` it will play one game locally. Logs and replays will be stored in `bots_battle` folder.

Run bots with enabled decision logger (use it only for debug, since it harms performance):

1. Run `make GAMES=1 ARGS=--logs run_battle`

## Run multiple bots to play one game

1. [Install Docker](https://docs.docker.com/get-docker/) and [Install Docker Compose](https://docs.docker.com/compose/install/)

1. Run `make build_docker`

1. Put bot configs to `project/settings/`. By default we are looking for these configs: `bot_1_settings.py`, `bot_2_settings.py`, `bot_3_settings.py`, `bot_4_settings.py`, `bot_5_settings.py`. Why 5 settings? Because tenhou doesn't start 2+ game in the custom lobby if you are running only 4 bots.

1. Run `make run_on_tenhou`

## Configuration instructions

1. Put your own settings to the `project/settings/settings_local.py` file. 

They will override settings from default `settings/base.py` file.

1. Also, you can override some default settings with command arguments. 

Use `python main.py -h` to check all available commands.

## Game reproducer

It can be useful to debug bot errors or strange discards: [game reproducer](doc/reproducer.md)