-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
49 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |