Giter Club home page Giter Club logo

osunowplaying's Introduction

osu!np

A now playing chat bot for osu! streamers!

About

osu!np is a simple application that retrieves current beatmap information (artist, creator, etc.) from osu! and sends it to the streamer's chat.

Installation

  1. Click here to download and install the latest release of .NET 6.
  2. Click here to download the latest osu!np release.
  3. Run the osu-np.exe executable.

Usage

The simplest way to use osu!np is with your own Twitch account.

  • Enter your username in the Username text field.
  • Click the (?) link next to the Token label or click here to open the Twitch Chat OAuth Password Generator website.
    • Click the Connect button and then the Authorise button.
  • Copy the token (including the oauth: at the start) from the website and paste it into the Token text field.
  • Click the Login button.

osu!np will now listen for / respond to the command !np in your chat.

Advanced Settings

Checking the Advanced check box reveals additional settings that allow you to change the channel osu!np listens to / responds in, the request command, and the response format.

These settings are optional and will default to the text shown in grey if left empty.

  • Channel: The channel osu!np will listen to / respond in.
  • Command: The command osu!np will respond to.
  • Format: The message osu!np will respond with. Supports patterns (see below).

Patterns

A pattern is a placeholder for beatmap information. When the command is sent in chat, the pattern will be replaced with the respective beatmap information (i.e. !artist! is replaced with xi).

Patterns are supported in the Format text field.

Patterns:

  • !artist! - The beatmap / song artist (i.e. xi).
  • !title! - The beatmap / song title (i.e. Blue Zenith).
  • !creator! - The beatmap creator / mapper (i.e. Asphyxia).
  • !version! - The beatmap version / difficulty (i.e. FOUR DIMENSIONS).
  • !sender! - The command user's username (i.e. TheOmyNomy).
  • !id! - The beatmap ID (i.e. 658127).
  • !set-id! - The beatmap set ID (i.e. 292301).

Example:

  • Format: @!sender! !artist! - !title! (!creator!) [!version!] - https://osu.ppy.sh/beatmaps/!id!
  • Response: @TheOmyNomy xi - Blue Zenith (Asphyxia) [FOUR DIMENSIONS] - https://osu.ppy.sh/beatmaps/658127

Licence

This software is licensed under the GNU General Public Licence 3.0 licence.

osunowplaying's People

Contributors

theomynomy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

osunowplaying's Issues

!link! not working

I tried to use it, but the !link! attribute is broken, always throws a broken link instead of the map link.
image
It is my config that's broken or the program itself?
image

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.