Code Monkey home page Code Monkey logo

osu-ahr's Introduction

osu-ahr

osu-ahr is auto host rotation bot for osu! multiplayer. The host rotation is managed with a queue. Players are added to the queue when joining a multiplayer room and sent to the back of the queue once their beatmap has been played.

Table of Contents

Bot Feature

Main page: Bot Usage Guides

These are what osu-ahr bot can do osu! bancho server:

  • Creating new multiplayer room
  • Managing existing multiplayer room
  • IRC chat support in managed multiplayer room
  • Managing host rotation queue
  • Add map selection regulation
  • Skipping current host
  • Starting the match
  • Aborting the match
  • Preventing AFK players from squatting the room
  • Closing the multiplayer room

Command List

Main page: Bot Command

Latest Version

For full changelog history, see: Changelog

Version 1.5.17

Code Quality

  • Add compiled JavaScript files for faster running option

Bot Installation

For bot configuration, see Bot Configuration article.

  1. Install Node.js and Git
  2. Clone this repository and install libraries
> git clone https://github.com/Meowhal/osu-ahr.git
> cd osu-ahr
> npm install
  1. Create a file ./config/local.json, use ./config/default.json as template.
  2. Get IRC password from osu! IRC Authentication
  3. Enter your account ID and IRC password to ./config/local.json as in the following example.
{
  "irc": {
    "server": "irc.ppy.sh",
    "nick": "[your account id]",
    "opt": {
      "port": 6667,
      "password": "[your account password]"
    }
  }
}
  1. (Optional) Configure the bot. See the Configuration article for details.
  2. Launch the bot. Note: You can also run your bot on Discord. See the Discord Integration article for details.
> npm run start
starting up...
Connecting to Osu Bancho ...
Connected :D

=== Welcome to osu-ahr ===

MainMenu Commands
  [make <Lobby_name>] Make a lobby.  e.g. 'make 5* auto host rotation'
  [enter <LobbyID>]   Enter the lobby. e.g. 'enter 123456' (It only works if you are a referee in the lobby).
  [help] Show this message.
  [quit] Quit the application.

> make 5-6* | auto host rotation

Bot Configuration

Main page: Bot Configuration

Special Thanks

osu-ahr's People

Contributors

meowhal avatar zeropyrozen avatar dependabot[bot] avatar metacinnabar avatar jramseygreen avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.