mirror of
https://gitlab.com/Kwoth/nadekobot.git
synced 2025-09-11 01:38:27 -04:00
Merge branch 'v4' of https://gitlab.com/kwoth/nadekobot into v4
This commit is contained in:
@@ -141,10 +141,16 @@ While there are two run modes built into the installer, these options only run N
|
|||||||
|
|
||||||
Using `tmux` is the simplest method, and is therefore recommended for most users.
|
Using `tmux` is the simplest method, and is therefore recommended for most users.
|
||||||
|
|
||||||
1. Start a tmux session:
|
**Before proceeding, make sure your bot is not running by either running `.die` in your Discord server or exiting the process with `Ctrl+C`.**
|
||||||
- `tmux`
|
|
||||||
|
If you are presented with the installer main menu, exit it by choosing Option `8`.
|
||||||
|
|
||||||
|
1. Create a new session: `tmux new -s nadeko`
|
||||||
|
|
||||||
|
The above command will create a new session named **nadeko** *(you can replace “nadeko” with anything you prefer, it's your session name)*.
|
||||||
|
|
||||||
2. Navigate to the project's root directory
|
2. Navigate to the project's root directory
|
||||||
- Project root directory location example: `/home/user/nadekobot/`
|
- Project root directory location example: `cd /home/user/nadekobot/`
|
||||||
3. Enter the `output` directory:
|
3. Enter the `output` directory:
|
||||||
- `cd output`
|
- `cd output`
|
||||||
4. Run the bot using:
|
4. Run the bot using:
|
||||||
@@ -152,8 +158,10 @@ Using `tmux` is the simplest method, and is therefore recommended for most users
|
|||||||
5. Detatch the tmux session:
|
5. Detatch the tmux session:
|
||||||
- Press `Ctrl` + `B`
|
- Press `Ctrl` + `B`
|
||||||
- Then press `D`
|
- Then press `D`
|
||||||
|
Now check your Discord server, the bot should be online. Nadeko should now be running in the background of your system.
|
||||||
|
|
||||||
|
To re-open the tmux session to either update, restart, or whatever, execute `tmux a -t nadeko`. *(Make sure to replace "nadeko" with your session name. If you didn't change it, leave it as it.)*
|
||||||
|
|
||||||
Nadeko should now be running in the background of your system. To re-open the tmux session to either update, restart, or whatever, execute `tmux a`.
|
|
||||||
|
|
||||||
### Systemd
|
### Systemd
|
||||||
|
|
||||||
|
@@ -24,7 +24,7 @@ This part is completely optional, **however it's necessary for music and a few o
|
|||||||
- Open up `creds.yml` and look for `GoogleAPIKey`, paste your API key after the `:`.
|
- Open up `creds.yml` and look for `GoogleAPIKey`, paste your API key after the `:`.
|
||||||
- It should look like this:
|
- It should look like this:
|
||||||
```yml
|
```yml
|
||||||
GoogleApiKey: AIzaSyDSci1sdlWQOWNVj1vlXxxxxxbk0oWMEzM
|
GoogleApiKey: 'AIzaSyDSci1sdlWQOWNVj1vlXxxxxxbk0oWMEzM'
|
||||||
```
|
```
|
||||||
- **MashapeKey**
|
- **MashapeKey**
|
||||||
- Required for Hearthstone cards.
|
- Required for Hearthstone cards.
|
||||||
@@ -40,16 +40,19 @@ This part is completely optional, **however it's necessary for music and a few o
|
|||||||
- For Patreon creators only.
|
- For Patreon creators only.
|
||||||
- **PatreonCampaignId**
|
- **PatreonCampaignId**
|
||||||
- For Patreon creators only. Id of your campaign.
|
- For Patreon creators only. Id of your campaign.
|
||||||
- **TwitchClientId**
|
- **TwitchClientId and TwitchClientSecret**
|
||||||
- Mandatory for following twitch streams with `.twitch` (or `.stadd` with twitch link)
|
- Mandatory for following twitch streams with `.twitch` (or `.stadd` with twitch link)
|
||||||
- Go to [apps page](https://dev.twitch.tv/console/apps/create) on twitch and register your application.
|
- Go to [apps page](https://dev.twitch.tv/console) on twitch and register your application.
|
||||||
- You need 2FA enabled on twitch in order to create an application
|
- You need 2FA enabled on twitch in order to create an application
|
||||||
- You can set `http://localhost` as the OAuth Redirect URL (and press Add button)
|
- You can set `http://localhost` as the OAuth Redirect URL (and press Add button)
|
||||||
- Select `Chat Bot` from the Category dropdown
|
- Select `Chat Bot` from the Category dropdown
|
||||||
- Once created, clicking on your application will show a new Client ID field
|
- Once created, `click Manage`
|
||||||
- Copy it to your creds.yml as shown below
|
- Click `New Secret` and select `OK` in the popup
|
||||||
|
**Note: You will need to generate a new Client Secret everytime you exit the page**
|
||||||
|
- Copy both to your creds.yml as shown below
|
||||||
```yml
|
```yml
|
||||||
TwitchClientId: "516tr61tr1qweqwe86trg3g"
|
twitchClientId: 516tr61tr1qweqwe86trg3g
|
||||||
|
twitchClientSecret: 16tr61tr1q86tweqwe
|
||||||
```
|
```
|
||||||
- **LocationIqApiKey**
|
- **LocationIqApiKey**
|
||||||
- Optional. Used only for the `.time` command. https://locationiq.com api key (register and you will receive the token in the email).
|
- Optional. Used only for the `.time` command. https://locationiq.com api key (register and you will receive the token in the email).
|
||||||
@@ -94,7 +97,7 @@ RestartCommand:
|
|||||||
|
|
||||||
```yml
|
```yml
|
||||||
# DO NOT CHANGE
|
# DO NOT CHANGE
|
||||||
version: 1
|
version: 4
|
||||||
# Bot token. Do not share with anyone ever -> https://discordapp.com/developers/applications/
|
# Bot token. Do not share with anyone ever -> https://discordapp.com/developers/applications/
|
||||||
token: 'MTE5Nzc3MDIxMzE5NTc3NjEw.VlhNCw.BuqJFyzdIUAK1PRf1eK1Cu89Jew'
|
token: 'MTE5Nzc3MDIxMzE5NTc3NjEw.VlhNCw.BuqJFyzdIUAK1PRf1eK1Cu89Jew'
|
||||||
# List of Ids of the users who have bot owner permissions
|
# List of Ids of the users who have bot owner permissions
|
||||||
@@ -153,6 +156,13 @@ timezoneDbApiKey:
|
|||||||
coinmarketcapApiKey:
|
coinmarketcapApiKey:
|
||||||
# Api key used for Osu related commands. Obtain this key at https://osu.ppy.sh/p/api
|
# Api key used for Osu related commands. Obtain this key at https://osu.ppy.sh/p/api
|
||||||
osuApiKey: 4c8c8fdffdsfdsfsdfsfa33f3f3140a7d93320d6
|
osuApiKey: 4c8c8fdffdsfdsfsdfsfa33f3f3140a7d93320d6
|
||||||
|
# Optional Trovo client id.
|
||||||
|
# You should use this if Trovo stream notifications stopped working or you're getting ratelimit errors.
|
||||||
|
trovoClientId:
|
||||||
|
# Obtain by creating an application at https://dev.twitch.tv/console/apps
|
||||||
|
twitchClientId: jf2w6kkyrlzfl6mp1b4k25h4jr6b2o
|
||||||
|
# Obtain by creating an application at https://dev.twitch.tv/console/apps
|
||||||
|
twitchClientSecret: 16tr61tr1q86tweqwe
|
||||||
# Command and args which will be used to restart the bot.
|
# Command and args which will be used to restart the bot.
|
||||||
# Only used if bot is executed directly (NOT through the coordinator)
|
# Only used if bot is executed directly (NOT through the coordinator)
|
||||||
# placeholders:
|
# placeholders:
|
||||||
|
Reference in New Issue
Block a user