Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Adivise committed May 19, 2022
1 parent c6c6b09 commit b87f0ec
Showing 1 changed file with 49 additions and 20 deletions.
69 changes: 49 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,63 @@
## Requirement
## πŸ“‘ Short Feature
- [x] Request Song
- [x] Check Current Skin Use
- [x] Nowplaying
- [x] Check PP When FC THIS MAP!
- [x] Easy to use!

1. Node.js **[Download](https://nodejs.org/en/download/)**
2. Gosumemory **[Download](https://github.com/l3lackShark/gosumemory)**
3. TMI OAUTH **[Click Here](https://twitchapps.com/tmi/)**
## 🚨 Have a Problem

## Installation
✈ Join Discord: [NanoSpace β™ͺβ™ͺ](https://discord.gg/SNG3dh3MbR)
mention me in chat #general or #javascript and ask problem okay! πŸ‘Œ

## πŸ“Ž Requirements

1. Node.js v16+ **[Download](https://nodejs.org/en/download/)**
2. TMI Oauth **[Click Here](https://twitchapps.com/tmi/)**
3. Gosumemory **[Download](https://github.com/l3lackShark/gosumemory)**
4. Osu IRC **[Click Here](https://osu.ppy.sh/p/irc)**

## πŸ“š Installation

```
git clone https://github.com/Adivise/Osus
cd osus
cd Osus
npm install
```

## Configuration
After installation finishes you can use `node .` to start the bot. or `Run Start.bat`

## πŸ“„ Configuration

Copy or Rename `.env.example` to `.env` and fill out the values:

Copy or Rename `config.json.example` to `config.json` and fill out the values:
```.env
# Bot
PREFIX=!
```json
{
"PREFIX": "!",
"USERNAME": "BOT_USERNAME",
"OAUTH": "BOT_OAUTH",
"CHANNEL": "TARGET_CHANNEL"
}
# Twitch https://twitchapps.com/tmi/
CHANNEL=nanotect_
USERNAME=adivise
OAUTH=oauth:123456789
# Osu! https://osu.ppy.sh/p/irc
OSU_NAME=prilz
OSU_PASS=dfasdfadf
```

After installation finishes please run `gosumemory.exe` first and start the bot. `Run #Start.bat` on the second! #but don't forget remember must open osu!
## πŸ”© Features & Commands

> Note: The default prefix is '!'
> Your can settings all in Folder `Settings`
> Optional: [] | Required: ()
## Picture
![see](https://i.imgur.com/ySgM02I.png)
![see](https://i.imgur.com/M6KFAsP.png)
πŸ’« **General Commands!**
- `!request (link)` - Request Song
- `!skin` - Check Current SKin
- `!ppfc` - Check PP THIS MAP WHEN FULLCOMBO
- `!nowplaying` - Check Nowplaying

Thank for api [l3lackShark](https://github.com/l3lackShark)
## πŸ“ Credits
Developed by [Adivise](https://github.com/Adivise)

0 comments on commit b87f0ec

Please sign in to comment.