https://github.com/MahjongRepository/mahjong_soul_api

Python wrapper for the Mahjong Soul (Majsoul) Protobuf objects. It allows to use their API.
https://github.com/MahjongRepository/mahjong_soul_api

mahjong mahjong-soul majsoul

Last synced: 3 months ago
JSON representation

Python wrapper for the Mahjong Soul (Majsoul) Protobuf objects. It allows to use their API.

• Host: GitHub
• URL: https://github.com/MahjongRepository/mahjong_soul_api
• Owner: MahjongRepository
• Created: 2019-10-12T03:51:19.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-22T07:22:18.000Z (6 months ago)
• Last Synced: 2024-01-09T05:33:21.516Z (6 months ago)
• Topics: mahjong, mahjong-soul, majsoul
• Language: Python
• Homepage:
• Size: 613 KB
• Stars: 59
• Watchers: 5
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Lists

• awesome-riichi - MahjongSoul API

README

        
The idea of repository based on https://github.com/chaserhkj/PyMajSoul/

Python wrappers for Majsoul allow you to interact with their servers from Python scripts.

## For User

1. Install python packages from `requirements.txt`

2. `python example.py -u username -p password`

This example is working only with **Python3.7+**.

Also, you need to have an account from CN server to run this example, because only accounts from CN server has the ability to login with login and password.

If you want to login to EN or JP servers you need to write your code to authenticate via email code or social network. Protobuf wrapper from this repository contains all needed API objects for that.

## For Developer

### Requirements

1. Install python packages from `requerements.txt`

1. Install protobuf compiler `sudo apt install protobuf-compiler`

### How to update protocol files to the new version

It was tested on Ubuntu.

1. Download the new `liqi.json` file from MS (find it in the network tab of your browser) and put it to `ms/liqi.json`

1. `python generate_proto_file.py`

1. `protoc --python_out=. protocol.proto`

1. `chmod +x ms-plugin.py`

1. `sudo cp ms-plugin.py /usr/bin/ms-plugin.py`

1. `protoc --custom_out=. --plugin=protoc-gen-custom=ms-plugin.py ./protocol.proto`

### How to update protocol files for manager API to the new version

1. Prepare new `liqi_admin.json` file from MS tournament manager panel

1. `python ms_tournament/generate_proto_file.py`

1. `protoc --python_out=. protocol_admin.proto`

1. `chmod +x ms-admin-plugin.py`

1. `sudo cp ms-admin-plugin.py /usr/bin/ms-admin-plugin.py`

1. `protoc --custom_out=. --plugin=protoc-gen-custom=ms-admin-plugin.py ./protocol_admin.proto`

### How to release new version

1. `pip install twine`

2. `python setup.py sdist`

3. `twine upload dist/*`