Silk! is a simple Discord bot written in C#. Silk! is built on top of the Remora.Discord .NET Discord library, with the goal to not only be a great bot but to also fill in the gaps that some bots have. Silk! aims to be a bot your members will want to use, while not being a cookie-cutter game, moderation, or entertainment bot. Silk! is also made with large guilds in mind. Feel free to join the Silk! Server to ask any questions you may have or any general support you may need. Want this bot on your server? Feel free to invite it!
Silk! is an open-source bot, and if you know C#, you're more than welcome to contribute! If you're on the server, and your PR gets merged, you get a nice light blue role on the server to signify your contributions. Active contributors are given a special role as well.
Silk! uses PostgreSQL for its backend database store. So if you don't have PostgreSQL installed, make sure to install it before trying to run the Visual Studio solution.
To manage storage of the needed Discord Bot Token, Database Connection String, and other important project configuration / settings, Silk! uses an appSettings.json file.
When you clone Silk!, before running the project, you'll need to edit the template appSettings.json file in the following directory: src\Silk
For the Database, look for the Persistence section of the file, it will look something like this:
"Persistence": {
"Host": "localhost",
"Port": "5432",
"Database": "silk",
"Username": "silk",
"Password": "silk"
}From there, just give the Username key a value (database user), and the Password key a value (password for the Postgres user).
For the Discord Bot Token, look for the Discord section of the file, it will look something like this:
"Discord": {
"Shards": 1,
"ClientId": "",
"ClientSecret": "",
"BotToken": ""
}From there, just give the BotToken key a value (your Discord Bot Token). If you are just starting with Discord Bots, then you can generate your Token and then copy it into your configuration file (use App Secrets!) - Discord Developer Portal.
Once there, locate and click the Applications menu item (usually in left side menu), then click on your application. Then you can either generate your token, or if you already have a bot, see if you can get the Token from existing application configuration that you're using, otherwise you'll need to reset your Token to have it revealed.
Silk! uses Redis for caching, and has a nifty plugin system using Remora.Plugins. These two pieces need just a bit of configuration, so please make sure not to skip!
In the same template appSettings.json, look for the following two sections: Plugins, Redis
The Plugins section will look something like this:
"Plugins": {
"RoleMenu": {
"Database": "Host=localhost;Port=5432;Database=silk_role_menu;Username=silk;Password=silk"
}
}Make sure to fill the Password part of the connection string for the RoleMenu plugin.
For the Redis section, it will look something like this:
"Redis": {
"Host": "localhost",
"Port": "6379",
"Password": ""
}Like above, make sure to fill the Password part of the connection string for Redis, and make any other needed changes to the Redis configuration (host or port changes).
The alternative, and more recommended way (but still NOT suitable for Production) for managing the configuration file is using User Secrets
The advantage of using User Secrets, is that the file is stored in a separate location from the project tree. Because of this, those secrets aren't checked into source control.
The location of the secrets.json file is different between Operating Systems, but it's stored in a system-protected user profile folder on your computer.
Windows
%APPDATA%\Microsoft\UserSecrets\VelvetThePanda-SilkBot\secrets.json
Mac / Linux
~/.microsoft/usersecrets/VelvetThePanda-SilkBot/secrets.json
In the Silk project, a UserSecretsId property is defined in the Silk.csproj file which looks like this:
<UserSecretsId>VelvetThePanda-Silk</UserSecretsId>The structure for the file is the same for the Default - appSettings.json approach. Copy what's in that template and paste it in the secrets.json file. Then fill in the needed pieces and you're good to go!
Before you start, you will want to make sure that you have both Postgres and Redis running and available to Silk!. If the services are running in docker, you'll wanna make sure that the appropriate ports are exposed on the container (5432 and 6379 respectively).
If Silk! is also running in Docker, ensure that it's within the same network as both Postgres and Redis. To connect, simply reference the container name instead of localhost or an IP (e.g. Server=silk).
If you're starting fresh, just cloned the repo, then you'll need to make sure you've done the needed Configuration, before running or debugging Silk!.
If you're already using Silk!, you may need to do any or all of the following to ensure that you have everything you need to run the latest and greatest!
Silk! will automatically apply any applicable migrations to the database. If you're starting with a clean database, this may take a few seconds.
To run Silk! as a docker container, you can simply create an appSettings.json file in the root directory, and run docker pull velvetthepanda/silk, assuming you have a postgres database running already. If not, you can download a pre-configured docker-compose file here.
The latest build can be viewed on Docker Hub
