/RhythmPy

a not so simple rhythm game bot

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

RhythmPy

GitHub Code style: black

A not so simple bot that plays rhythm games for you im still working on this btw :p Click here for the roadmap and planned features

Supported Games

  • Quaver
    • 4K Mania
    • 7K Mania
  • Osu
    • 4K Mania
    • 7K Mania
    • Osu!

Installation

RhythmPy has been tested to work with python versions 3.7 or lower.
In theory this project should work on Mac / Linux but i have not tested it yet

Method 1: Using the official release installers

Method 2: Running / Building the source
This project is made using make if you are on windows you will need to install make before proceeding.

  • Use make python to run the python version
  • Use make build && make run to build and run

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch git checkout -b feature/AmazingFeature
  3. Commit your Changes git commit -m 'Add some AmazingFeature'
  4. Push to the Branch git push origin feature/AmazingFeature
  5. Open a Pull Request

i will review the pull request as soon as i can

Building from source

  1. Follow installation guide to step 3
  2. install Dev version of RhythmPy poetry install

Method 1 Using premade script:

  • 3᎐ Run poetry run python Build.py and follow in terminal instructions

Method 2: Using pyinstaller

  • 3.1 OPTIONAL Create your own .spec file poetry run pyi-makespec RhythmPy/__main__.py and Fill in needed information click here for example. you will need to define where the ui elements can be found
  • 3.2 Run poetry run pyinstaller --onedir RhythmPy/RhythmPy.spec RhythmPy/__main__.py to create the .exe
  1. Open the executable found in dist/RhythmPy to run the program

After building is done there should be two folders build and dist if they do not appear or if the generated executable does not work please install Visual C++ Redistributable
if that does not work recompile with --debug=all as an option and then check the logs in build/Main

if you want to create a installer use nsis, i am not going to cover how to do it here due to it being rather simple

Disclaimer

By downloading this program you agree that you and you alone will be held responsible for any banned accounts that may or may not occur. It is completely up to you if you use any of the following Tools or any other Third-Party Application that in any way is breaking the EULA or TOS of the game.
Full Disclaimer