Asuka

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing

About The Project

This is Asuka, a Discord bot created by faldyif mainly for osu! tracking. Because this project is currently work in progress, it only supports the following features:

• Modular multi server support
• User Profiles (std/mania/taiko/ctb)
• User Most Recent Play
• Compare Play

Supported osu! Servers

• Bancho (Default)
• Datenshi
• Akatsuki
• Ripple

Built With

• Typescript
• discord.js
• Moment.js
• ts-jest

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is the things you need to use the software and how to install them.

• Node.js 12.0.0 or newer
• Redis
• npm

npm install npm@latest -g

• node-ts (for running without compiling)

npm install node-ts -g

Installation

1. Clone the repo

git clone git@github.com:faldyif/asuka.git

2. Install NPM packages

npm i

3. Copy the .env.example to .env

cp .env.example .env

4. Copy the .env.example to .env

cp .env.example .env

5. Configure the .env file that's been copied before
6. Run npm start or npm debug for running without compiling

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make our work easier. Any contributions you make are greatly appreciated.

1. Clone 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

Notes:

• Consider using emoji for commit messages. Because every commit is important. So let's celebrate each and every commit with a corresponding emoji! 😄 (Example)