RPCS3/discord-bot
1
0
Fork 0
mirror of https://github.com/RPCS3/discord-bot.git synced 2024-11-23 02:09:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Source code for RPCS3's Discord bot.
2,361 Commits 3 Branches 0 Tags 7.9 MiB
C# 99.3%
PowerShell 0.6%
a48ba2400c
Go to file
XenoFantom a48ba2400c
Update fortunes.txt
2021-03-09 12:40:43 -07:00
.github/workflows Update codeql-analysis.yml 2020-11-19 01:52:59 +05:00
Clients update dependencies 2021-03-03 20:04:44 +05:00
CompatBot autorename users on audit 2021-03-09 14:06:02 +05:00
HomoglyphConverter add win32 error code reference (with errata) 2021-02-16 20:11:11 +05:00
SourceGenerators workaround new bug in discord client 2021-03-03 20:26:49 +05:00
Tests remove all private use symbols from usernames 2021-03-09 13:54:37 +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 update CI and docker scripts 2020-11-10 22:05:52 +05:00
CONTRIBUTING.md update readme 2019-11-05 01:31:04 +05:00
discord-bot-net.sln replace runtime builder with source generator for unicode confusables 2021-01-28 20:11:26 +05:00
discord-bot-net.sln.DotSettings fix resharper warnings 2020-11-14 15:58:16 +05:00
docker-compose.example.yml fml 2019-10-26 18:37:16 +05:00
Dockerfile ugh 2021-01-27 22:11:49 +05:00
fortunes.txt Update fortunes.txt 2021-03-09 12:40:43 -07: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 2020-08-16 13:49:34 +05:00
README.md add win32 error code reference (with errata) 2021-02-16 20:11:11 +05:00
SECURITY.md Create SECURITY.md 2019-06-05 23:48:49 +05:00
win32_error_codes.txt add win32 error code reference (with errata) 2021-02-16 20:11:11 +05:00

README.md

RPCS3 Compatibility Bot

Build Status RPCS3 discord server

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

Runtime Requirements

  • .NET 5.0 SDK or newer to run from sources
    • bot needs dotnet command to be available (i.e. alias for the Snap package)
  • 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

How to Build

  • 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]

How to Run in Production

Running from source

  • 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

Running with Docker

  • 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).

External resources that need manual updates