Skip to content

Commit

Permalink
Relative paths to .md file don't work, so changed it to absolute paths.
Browse files Browse the repository at this point in the history
Fixed note, caution, warning blocks.
  • Loading branch information
AlexInCube committed Jul 6, 2024
1 parent ea09e8a commit 1321681
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 13 deletions.
10 changes: 5 additions & 5 deletions wiki/API-Configure.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[!Caution]
[!CAUTION]
Don't share this API data with anyone because you can get compromised.
If this happens, reset the tokens and get them again.

Expand All @@ -21,12 +21,12 @@ You can edit your application's name, description, and avatar here. Once you've

![discord-dev-enable-intents](./images/discord-dev-enable-intents.png)

## 🍪 YouTube Cookie (optional)
## YouTube Cookie (optional)
Preferable to provide cookies for YouTube.
This will allow you to play 18+ videos and bypass YouTube rate limiting error (429 Error).
I highly recommend that you create a new Google account from which you can get the cookie.

[!Warning]
[!WARNING]
Time to time, cookies are resets by YouTube, so you need to retrieve it again.
It's so annoying, but hasn't figured out a way to automate the cookie retrieval process.
If you know workaround, please create the [issue](https://github.com/AlexInCube/AlCoTest/issues/new/choose)
Expand All @@ -40,7 +40,7 @@ If you know workaround, please create the [issue](https://github.com/AlexInCube/
## Yandex Music (optional)
If you do not provide token and UID, Yandex Music will not work at all.

[!Warning]
[!WARNING]
If your bot is outside Russia VDS, you must have a Yandex Plus subscription to play songs.

### Token
Expand All @@ -57,7 +57,7 @@ This must look like this ![yandex-extension](./images/yandex-music-extension.png
## Spotify (optional)
Spotify Module can work without provided data, but for more stability better provide custom application data.

[!Warning]
[!WARNING]
If you want to fetch playlist with more than 100 songs, this API data is required!

1. Login in [Spotify Developer Dashboard](https://developer.spotify.com/dashboard)
Expand Down
15 changes: 7 additions & 8 deletions wiki/Setup.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# How to setup bot?
## ⚙️ Configure .env
You can use Docker Compose or install all dependencies and source code locally.
But in both cases, you need to configure .env file.
Expand All @@ -7,10 +6,10 @@ Also you need retrieve token, client id and enable intents on Discord Developer

- Create file .env.production
- Fill all fields in .env.production. If the field is marked as (Optional), you can skip it.
- (Required) To get Discord Token and enable intents, follow the [Discord Developer Portal](API-Configure.md#discord-developer-portal-required) section.
- (Optional) To get Spotify Secret and ID, follow the [Spotify](API-Configure.md#spotify-optional) section.
- (Optional) To get Yandex Music token, follow the [Yandex Music](API-Configure.md#yandex-music-optional) section.
- (Optional) To get SoundCloud token, follow the [Soundcloud](API-Configure.md#soundcloud-optional) section.
- (Required) To get Discord Token and enable intents, follow the [Discord Developer Portal](https://github.com/AlexInCube/AlCoTest/wiki/API-Configure#discord-developer-portal-required) section.
- (Optional) To get Spotify Secret and ID, follow the [Spotify](https://github.com/AlexInCube/AlCoTest/wiki/API-Configure#spotify-optional) section.
- (Optional) To get Yandex Music token, follow the [Yandex Music](https://github.com/AlexInCube/AlCoTest/wiki/API-Configure#yandex-music-optional) section.
- (Optional) To get SoundCloud token, follow the [Soundcloud](https://github.com/AlexInCube/AlCoTest/wiki/API-Configure#soundcloud-optional) section.

| Name | Example | Description | Required? |
|------------------------------|-----------------------|-------------------------------------------------------------------------|-----------|
Expand All @@ -30,13 +29,13 @@ Also you need retrieve token, client id and enable intents on Discord Developer
| `BOT_SOUNDCLOUD_TOKEN` | | Provide to fetch more data with SoundCloud Go+ account ||

## 🐋 Run in Docker (recommended)
[!Note]
[!NOTE]
Using Docker provides the auto-update feature

- Install [Docker](https://www.docker.com/get-started/)
- Copy docker-compose.yml, Dockerfile in empty folder
- Follow the [Configure .env](#-configure-env) section and copy .env.production in folder with docker-compose.yml etc.
- (Optional) Follow the [YouTube Cookie](API-Configure.md#-youtube-cookie-optional) section and copy yt-cookies.json in the folder with docker-compose.yml etc.
- (Optional) Follow the [YouTube Cookie](https://github.com/AlexInCube/AlCoTest/wiki/API-Configure#-youtube-cookie-optional) section and copy yt-cookies.json in the folder with docker-compose.yml etc.
- Your file structure must be like this
```
AICoTest/
Expand All @@ -53,7 +52,7 @@ AICoTest/
- Install FFMpeg. Follow this [guide](https://www.wikihow.com/Install-FFmpeg-on-Windows)
- Clone repository to your computer
- Follow the [Configure .env](#-configure-env) section and copy .env.production in folder with repository.
- (Optional) Follow the [YouTube Cookie](API-Configure.md#-youtube-cookie-optional) and copy yt-cookies.json in the folder with repository.
- (Optional) Follow the [YouTube Cookie](https://github.com/AlexInCube/AlCoTest/wiki/API-Configure#-youtube-cookie-optional) and copy yt-cookies.json in the folder with repository.
- Install Node.js packages in the folder with repository
```npm
npm install
Expand Down

0 comments on commit 1321681

Please sign in to comment.