mirror of https://github.com/RPCS3/discord-bot.git synced 2024-11-30 13:40:30 +00:00

Source code for RPCS3's Discord bot.

Go to file

13xforever 9f627be7f0 add dummy cirrus ci config		2020-05-23 14:22:07 +05:00
Clients	increase readability	2020-05-22 02:08:17 +05:00
CompatBot	add dummy cirrus ci config	2020-05-23 14:22:07 +05:00
HomoglyphConverter	tweak some zalgo stripping and filter stripping of strings	2019-12-01 19:04:49 +05:00
Tests	update dependencies	2020-05-01 14:51:33 +05:00
.cirrus.yml	add dummy cirrus ci config	2020-05-23 14:22:07 +05:00
.dockerignore	better azure pipelines integration and building docker image	2019-09-19 23:32:05 +05:00
.gitattributes	RPCS3 Compatibility Bot reimplemented in C# for .NET Core	2018-07-20 09:22:28 +02:00
.gitignore	Google Drive handler	2019-03-01 05:47:06 +05:00
architecture.md	some docs	2019-04-01 22:52:27 +05:00
azure-pipelines.yml	add azure job timeout for build & test	2020-05-01 15:05:40 +05:00
CONTRIBUTING.md	update readme	2019-11-05 01:31:04 +05:00
discord-bot-net.sln	add dummy cirrus ci config	2020-05-23 14:22:07 +05:00
discord-bot-net.sln.DotSettings	increase throttling to 1 day to reduce spam	2019-10-12 01:52:26 +05:00
docker-compose.example.yml	fml	2019-10-26 18:37:16 +05:00
Dockerfile	upgrade dotnet sdk to 3.1	2019-12-07 22:06:48 +05:00
LICENSE	RPCS3 Compatibility Bot reimplemented in C# for .NET Core	2018-07-20 09:22:28 +02:00
metacritic_ps3.json	tweak mc import to cover all available games	2020-04-03 21:02:55 +05:00
nuget.config	update deps	2019-07-14 13:53:46 +05:00
README.md	upgrade dotnet sdk to 3.1	2019-12-07 22:06:48 +05:00
SECURITY.md	Create SECURITY.md	2019-06-05 23:48:49 +05:00

RPCS3 Compatibility Bot

This is a tech support / moderation / crowd entertainment bot for the RPCS3 discord server.

You can read the design and implementation notes by visiting the folders in the web interface, or from the architecture overview notes.

Development Requirements

.NET Core 3.1 SDK or newer
Any text editor, but here are some recommends:
- Visual Studio (Windows and Mac only, has free Community edition)
- Visual Studio Code (cross-platform, free)
- JetBrains Rider (cross-platform)

.NET Core 3.1 SDK or newer to run from sources
- needs dotnet command available (i.e. alias for the Snap package)
.NET Core 3.1 Runtime for server apps or newer for compiled version
Optionally Google API credentials to access Google Drive:
- Create new project in the Google Cloud Resource Manager
- Select the project and enable Google Drive API
- Open API & Services Credentials
- Create new credentials:
  - Service account credentials
  - New service account
    - if you select an existing account, new credentials will be generated in addition to previous any ones
  - Role Project > Viewer
  - Key type JSON
  - Create will generate a configuration file
- Save said configuration file as credentials.json in user secrets folder
  - e.g on Linux this will be ~/.microsoft/usersecrets/c2e6548b-b215-4a18-a010-958ef294b310/credentials.json

Change configuration for test server in CompatBot/Properties/launchSettings.json
Note that token could be set in the settings or supplied as a launch argument (higher priority)
If you've changed the database model, add a migration
- $ dotnet tool install --global dotnet-ef (if you have never installed the tools before)
- $ cd CompatBot
- $ dotnet ef migrations add -c [BotDb|ThumbnailDb] MigrationName
- $ cd ..
$ cd CompatBot
$ dotnet run [token]

Change configuration if needed (probably just token):
- use $ dotnet user-secrets set Token <your_token_here>
- for available configuration variables, see Config.cs
Put bot.db in CompatBot/ if you have one
$ cd CompatBot
$ dotnet run -c Release

Official image is hosted on Docker Hub.
You should pull images tagged with release-latest (same thing as latest)
Please take a look at the docker-compose.yml for required configuration (bot token and mounting points for persistent data).