mirror of
https://gitlab.com/Kwoth/nadekobot.git
synced 2025-09-10 09:18:27 -04:00
Updated links to be relative, updated readme with black theme. Small updates
This commit is contained in:
3
.gitignore
vendored
3
.gitignore
vendored
@@ -8,7 +8,8 @@ src/NadekoBot/creds.yml
|
|||||||
src/NadekoBot/Command Errors*.txt
|
src/NadekoBot/Command Errors*.txt
|
||||||
|
|
||||||
src/NadekoBot/creds.yml
|
src/NadekoBot/creds.yml
|
||||||
# credentials file after migrations
|
# credentials file before and after migrations
|
||||||
|
src/NadekoBot/credentials.json
|
||||||
src/NadekoBot/old_credentials.json
|
src/NadekoBot/old_credentials.json
|
||||||
src/NadekoBot/credentials.json.bak
|
src/NadekoBot/credentials.json.bak
|
||||||
src/NadekoBot/data/NadekoBot.db
|
src/NadekoBot/data/NadekoBot.db
|
||||||
|
10
CHANGELOG.md
10
CHANGELOG.md
@@ -8,16 +8,18 @@ Experimental changelog. Mostly based on [keepachangelog](https://keepachangelog.
|
|||||||
|
|
||||||
- Renamed `credentials.json` to `creds.yml` (example in `creds_example.yml`)
|
- Renamed `credentials.json` to `creds.yml` (example in `creds_example.yml`)
|
||||||
- Most of the credentials from 2.x will be automatically migrated
|
- Most of the credentials from 2.x will be automatically migrated
|
||||||
|
- Explanations on how to get the keys are added as the comments
|
||||||
- Code cleanup
|
- Code cleanup
|
||||||
- Command attributes cleaned up
|
- Command attributes cleaned up
|
||||||
- Removed dummy Remarks and Usages attributes as hey were unused for a few patches but stayed in the code to avoid big git diffsmigration code has ran and it can be safely removed
|
- Removed dummy Remarks and Usages attributes as hey were unused for a few patches but stayed in the code to avoid big git diffsmigration code has ran and it can be safely removed
|
||||||
- There are 2 projects: NadekoBot and NadekoBot.Coordinator
|
- There are 2 projects: NadekoBot and NadekoBot.Coordinator
|
||||||
- You can directly run NadekoBot as the regular bot with one shard
|
- You can directly run NadekoBot as the regular bot with one shard
|
||||||
- Run NadekoBot.Coordinator if you want more control over your shards and a grpc api for coordinator with which you can start, restart, kill and see status of shards
|
- Run NadekoBot.Coordinator if you want more control over your shards and a grpc api for coordinator with which you can start, restart, kill and see status of shards
|
||||||
- todo: Reworked from source installation (linux/windows) guide <todo link>
|
- Small performance improvements
|
||||||
- todo: Added docker support, installation guide at <todo link>
|
- Db Migrations squashed
|
||||||
- Guides
|
- A lot of cleanup all around
|
||||||
- Now instruct users to set build output to nadekobot/output instead of running from nadekobot/src/NadekoBot
|
- Many guides reworked
|
||||||
|
- Guides now instruct users to set build output to nadekobot/output instead of running from nadekobot/src/NadekoBot
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
|
@@ -3,9 +3,11 @@
|
|||||||
[](https://top.gg/bot/116275390695079945)
|
[](https://top.gg/bot/116275390695079945)
|
||||||
|
|
||||||
|
|
||||||
[](https://nadeko.bot/)
|
[](https://nadeko.bot/)
|
||||||
[](https://invite.nadeko.bot/)
|
|
||||||
[](https://nadeko.bot/commands)
|
[](https://invite.nadeko.bot/)
|
||||||
|
|
||||||
|
[](https://nadeko.bot/commands)
|
||||||
|
|
||||||
### Useful links
|
### Useful links
|
||||||
- ❗ [2.x to v3 migration guide](https://nadekobot.readthedocs.io/en/v3/guides/migration-guide/)
|
- ❗ [2.x to v3 migration guide](https://nadekobot.readthedocs.io/en/v3/guides/migration-guide/)
|
||||||
|
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
##### ⚠ If you're already hosting NadekoBot, _You **MUST** update to latest version of 2.x and **run your bot at least once**_ before switching over to v3.
|
##### ⚠ If you're already hosting NadekoBot, _You **MUST** update to latest version of 2.x and **run your bot at least once**_ before switching over to v3.
|
||||||
|
|
||||||
#### [Linux migration instructions](https://nadekobot.readthedocs.io/en/v3/guides/migration-guide/#linux)
|
#### [Linux migration instructions](../migration-guide/#linux)
|
||||||
|
|
||||||
## Linux From Source
|
## Linux From Source
|
||||||
|
|
||||||
@@ -17,7 +17,7 @@ Open Terminal (if you're on an installation with a window manager) and navigate
|
|||||||
5. Copy the creds.yml template `cp nadekobot/output/creds_example.yml nadekobot/output/creds.yml`
|
5. Copy the creds.yml template `cp nadekobot/output/creds_example.yml nadekobot/output/creds.yml`
|
||||||
6. Open `nadekobot/output/creds.yml` with your favorite text editor. We will use nano here
|
6. Open `nadekobot/output/creds.yml` with your favorite text editor. We will use nano here
|
||||||
- `nano nadekobot/output/creds.yml`
|
- `nano nadekobot/output/creds.yml`
|
||||||
7. [Enter your bot's token](https://nadekobot.readthedocs.io/en/v3/creds-guide/)
|
7. [Enter your bot's token](../../creds-guide)
|
||||||
- After you're done, you can close nano (and save the file) by inputting, in order
|
- After you're done, you can close nano (and save the file) by inputting, in order
|
||||||
- `CTRL` + `X`
|
- `CTRL` + `X`
|
||||||
- `Y`
|
- `Y`
|
||||||
|
@@ -32,7 +32,7 @@
|
|||||||
- `.stats` to ensure owner id (credentials) is correct
|
- `.stats` to ensure owner id (credentials) is correct
|
||||||
- `.lcr` to see custom reactions
|
- `.lcr` to see custom reactions
|
||||||
- `.lp` to list permissions
|
- `.lp` to list permissions
|
||||||
5. 🎉 Enjoy. If you want to learn how to update the bot, click (here)[https://nadekobot.readthedocs.io/en/v3/guides/linux-guide/#update-instructions].
|
5. 🎉 Enjoy. If you want to learn how to update the bot, click (here)[../linux-guide/#update-instructions].
|
||||||
|
|
||||||
## Manual
|
## Manual
|
||||||
|
|
||||||
|
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
⚠ If you're already hosting NadekoBot, You **MUST** update to latest version of 2.x and **run your bot at least once** before switching over to v3.
|
⚠ If you're already hosting NadekoBot, You **MUST** update to latest version of 2.x and **run your bot at least once** before switching over to v3.
|
||||||
|
|
||||||
#### [Windows migration instructions](migration-instructions#windows)
|
#### [Windows migration instructions](../migration-guide#windows)
|
||||||
|
|
||||||
## Setting Up NadekoBot on Windows With the Updater
|
## Setting Up NadekoBot on Windows With the Updater
|
||||||
|
|
||||||
|
@@ -18,7 +18,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.
|
||||||
|
Reference in New Issue
Block a user