minster586/nadekobot
1
0
Fork 0
mirror of https://gitlab.com/Kwoth/nadekobot.git synced 2025-09-10 09:18:27 -04:00
Code Issues Packages Projects Releases Wiki Activity

- Initial work on Dockerfile

Browse Source 
- Updated README.md with more information
- Added some todos
This commit is contained in:
Kwoth
2021-07-18 09:16:42 +02:00
parent 971b5078b7
commit b84f40def6
7 changed files with 51 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -2,7 +2,7 @@
## Migration from 2.x
:warning: You **MUST** update to latest version of 2.x and **run yourbot at least once** before switching over to v3
:warning: You **MUST** update to latest version of 2.x and **run your bot at least once** before switching over to v3
## Changes
@@ -13,12 +13,12 @@
- All database migrations and data (json file) migrations have been removed
- As updating to the latest 2.x version before switching over to v3 is mandated (or fresh v3install), that means all migration code has ran and it can be safely removed
- There are 2 projects: NadekoBot and NadekoBot.Coordinator
- NadekoBot is the regular bot with one shard, or if you can run it if you want to run your shards
- credentials.json moved to `creds.yml`, example is in `creds_example.yml`, most of the credentials from 2.x will be automatically migrated
- Guide will now instruct users to set build output to nadekobot/output instead of running from nadekobot/src/NadekoBot/bin/release/net5
- todo: Reworked from source installation (linux/windows) guide <todo link>
- todo: Added docker installation guide at <todo link>
- todo?: votes functionality changed
- todo?: maybe use https://github.com/Humanizr/Humanizer for trimto, time printing, date printing, etc
- todo?: use guild locale more in the code (from guild settings) (for dates, currency, etc?)
- todo?: Write a sourcegen for response strings and use const/static fields (maybe even typed to enforce correct number of arguments)
- 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
- credentials.json moved to `creds.yml`
- example is in `creds_example.yml`
- most of the credentials from 2.x will be automatically migrated
- Guides
- Now instruct users to set build output to nadekobot/output instead of running from nadekobot/src/NadekoBot/bin/release/net5
- todo: Reworked from source installation (linux/windows) guide <todo link>
- todo: Added docker support, installation guide at <todo link>