discord-bot/README.md

RPCS3 Compatibility Bot
=======================

This is a tech support / moderation / crowd entertainment bot for the [RPCS3 discord server](https://discord.me/rpcs3) [![RPCS3 discord server](https://discordapp.com/api/guilds/272035812277878785/widget.png)](https://discord.me/rpcs3)

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

Development Requirements
------------------------
* [.NET Core 2.1 SDK](https://www.microsoft.com/net/download/windows) or newer
* Any text editor, but here are some recommends:
  * [Visual Studio](https://visualstudio.microsoft.com/) (Windows and Mac only, has free Community edition)
  * [Visual Studio Code](https://code.visualstudio.com/) (cross-platform, free)
  * [JetBrains Rider](https://www.jetbrains.com/rider/) (cross-platform)

Runtime Requirements
--------------------
* [.NET Core 2.1 SDK](https://www.microsoft.com/net/download/windows) or newer to run from sources
  * needs `dotnet` command available (i.e. alias for the Snap package)
* [.NET Core 2.1 Runtime](https://www.microsoft.com/net/download/windows) or newer for compiled version
* Optionally Google API credentials to access Google Drive:
  * Create new project in the [Google Cloud Resource Manager](https://console.developers.google.com/cloud-resource-manager)
  * Select the project and enable [Google Drive API](https://console.developers.google.com/apis/library/drive.googleapis.com)
  * Open [API & Services Credentials](https://console.developers.google.com/apis/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](https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-2.2#how-the-secret-manager-tool-works) 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
	* `$ cd CompatBot`
	* `$ dotnet ef migrations add -c [BotDb|ThumbnailDb] MigrationName`
	* `$ cd ..`
* `$ cd CompatBot`
* `$ dotnet run [token]`

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

External resources that need manual updates
-------------------------------------------
* [Unicode confusables](http://www.unicode.org/Public/security/latest/confusables.txt) gzipped, for Homoglyph checks
* Optionally [Redump disc key database](http://redump.org/downloads/) in text format (requires membership)
scrape only full game lists in PSN stores, also cache title names new isssue detections for log parser consistent reaction with emoji only / text when can't ability to disable commands at runtime (fixes #56) command to check for game updates various other bugfixes 2018-08-05 14:36:16 +00:00			`RPCS3 Compatibility Bot`
			`=======================`
+ vs code settings for debug + actual readme with quickstart instructions 2018-02-16 15:58:05 +00:00
update readme 2019-02-13 16:40:59 +00:00			`This is a tech support / moderation / crowd entertainment bot for the [RPCS3 discord server](https://discord.me/rpcs3) [![RPCS3 discord server](https://discordapp.com/api/guilds/272035812277878785/widget.png)](https://discord.me/rpcs3)`

some docs 2019-03-29 14:51:44 +00:00			`You can read the design and implementation notes by visiting the folders in the web interface, or from the [architecture overview notes](architecture.md).`

RPCS3 Compatibility Bot reimplemented in C# for .NET Core RPCS3 Compatibility Bot reimplemented in C# for .NET Core Current status of this PR: * tested and targeted for .NET Core 2.1 * all functionality is either on par or improved compared to the python version * compatibility with current bot.db should be preserved in all upgrade scenarios * some bot management commands were changed (now under !sudo bot) * standard help generator for the new discord client is ... different; compatibility with old format could be restored through custom formatter if needed * everything has been split in more loosely tied components for easier extensibility and maintenance * log parsing has been rewritten and should work ~2x as fast 2018-07-19 12:42:48 +00:00			`Development Requirements`
			`------------------------`
			`* [.NET Core 2.1 SDK](https://www.microsoft.com/net/download/windows) or newer`
update readme 2019-02-13 16:40:59 +00:00			`* Any text editor, but here are some recommends:`
			`* [Visual Studio](https://visualstudio.microsoft.com/) (Windows and Mac only, has free Community edition)`
			`* [Visual Studio Code](https://code.visualstudio.com/) (cross-platform, free)`
			`* [JetBrains Rider](https://www.jetbrains.com/rider/) (cross-platform)`
+ vs code settings for debug + actual readme with quickstart instructions 2018-02-16 15:58:05 +00:00
RPCS3 Compatibility Bot reimplemented in C# for .NET Core RPCS3 Compatibility Bot reimplemented in C# for .NET Core Current status of this PR: * tested and targeted for .NET Core 2.1 * all functionality is either on par or improved compared to the python version * compatibility with current bot.db should be preserved in all upgrade scenarios * some bot management commands were changed (now under !sudo bot) * standard help generator for the new discord client is ... different; compatibility with old format could be restored through custom formatter if needed * everything has been split in more loosely tied components for easier extensibility and maintenance * log parsing has been rewritten and should work ~2x as fast 2018-07-19 12:42:48 +00:00			`Runtime Requirements`
			`--------------------`
			`* [.NET Core 2.1 SDK](https://www.microsoft.com/net/download/windows) or newer to run from sources`
Google Drive handler 2019-03-01 00:47:06 +00:00			* needs `dotnet` command available (i.e. alias for the Snap package)
update readme 2019-02-02 15:03:51 +00:00			`* [.NET Core 2.1 Runtime](https://www.microsoft.com/net/download/windows) or newer for compiled version`
Google Drive handler 2019-03-01 00:47:06 +00:00			`* Optionally Google API credentials to access Google Drive:`
			`* Create new project in the [Google Cloud Resource Manager](https://console.developers.google.com/cloud-resource-manager)`
fix the issue with "Log is copied from UI" fix instructions for Google Drive API configuration 2019-03-01 09:06:55 +00:00			`* Select the project and enable [Google Drive API](https://console.developers.google.com/apis/library/drive.googleapis.com)`
some docs 2019-03-29 14:51:44 +00:00			`* Open [API & Services Credentials](https://console.developers.google.com/apis/credentials)`
Google Drive handler 2019-03-01 00:47:06 +00:00			`* Create new credentials:`
			`* Service account credentials`
			`* New service account`
Update README.md 2019-03-01 17:52:52 +00:00			`* if you select an existing account, new credentials will be generated in addition to previous any ones`
			`* Role Project > Viewer`
Google Drive handler 2019-03-01 00:47:06 +00:00			`* Key type JSON`
fix the issue with "Log is copied from UI" fix instructions for Google Drive API configuration 2019-03-01 09:06:55 +00:00			`* Create will generate a configuration file`
Update README.md 2019-03-01 17:52:52 +00:00			* Save said configuration file as `credentials.json` in [user secrets](https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-2.2#how-the-secret-manager-tool-works) folder
ability to use google credentials stored in user-secrets folder updated README to reflect this 2019-03-01 17:34:39 +00:00			* e.g on Linux this will be `~/.microsoft/usersecrets/c2e6548b-b215-4a18-a010-958ef294b310/credentials.json`
+ vs code settings for debug + actual readme with quickstart instructions 2018-02-16 15:58:05 +00:00
RPCS3 Compatibility Bot reimplemented in C# for .NET Core RPCS3 Compatibility Bot reimplemented in C# for .NET Core Current status of this PR: * tested and targeted for .NET Core 2.1 * all functionality is either on par or improved compared to the python version * compatibility with current bot.db should be preserved in all upgrade scenarios * some bot management commands were changed (now under !sudo bot) * standard help generator for the new discord client is ... different; compatibility with old format could be restored through custom formatter if needed * everything has been split in more loosely tied components for easier extensibility and maintenance * log parsing has been rewritten and should work ~2x as fast 2018-07-19 12:42:48 +00:00			`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`
			* `$ cd CompatBot`
implemented some rudimentary psn api client implemented psn crawling for ps3 game metadata (mostly for thumbnails) implemented game thumbnails for game embeds fixed usage of dbcontext some other bugfixes 2018-08-03 16:39:57 +00:00			* `$ dotnet ef migrations add -c [BotDb\|ThumbnailDb] MigrationName`
RPCS3 Compatibility Bot reimplemented in C# for .NET Core RPCS3 Compatibility Bot reimplemented in C# for .NET Core Current status of this PR: * tested and targeted for .NET Core 2.1 * all functionality is either on par or improved compared to the python version * compatibility with current bot.db should be preserved in all upgrade scenarios * some bot management commands were changed (now under !sudo bot) * standard help generator for the new discord client is ... different; compatibility with old format could be restored through custom formatter if needed * everything has been split in more loosely tied components for easier extensibility and maintenance * log parsing has been rewritten and should work ~2x as fast 2018-07-19 12:42:48 +00:00			* `$ cd ..`
			* `$ cd CompatBot`
			* `$ dotnet run [token]`
+ vs code settings for debug + actual readme with quickstart instructions 2018-02-16 15:58:05 +00:00
RPCS3 Compatibility Bot reimplemented in C# for .NET Core RPCS3 Compatibility Bot reimplemented in C# for .NET Core Current status of this PR: * tested and targeted for .NET Core 2.1 * all functionality is either on par or improved compared to the python version * compatibility with current bot.db should be preserved in all upgrade scenarios * some bot management commands were changed (now under !sudo bot) * standard help generator for the new discord client is ... different; compatibility with old format could be restored through custom formatter if needed * everything has been split in more loosely tied components for easier extensibility and maintenance * log parsing has been rewritten and should work ~2x as fast 2018-07-19 12:42:48 +00:00			`How to Run in Production`
			`------------------------`
Update README.md 2019-03-01 17:52:52 +00:00			`* Change configuration if needed (probably just token):`
fix compiler warnings 2019-03-01 10:56:54 +00:00			* use `$ dotnet user-secrets set Token <your_token_here>`
Update README.md 2019-03-01 17:52:52 +00:00			`* for available configuration variables, see [Config.cs](CompatBot/Config.cs#L31)`
			* Put `bot.db` in `CompatBot/` if you have one
RPCS3 Compatibility Bot reimplemented in C# for .NET Core RPCS3 Compatibility Bot reimplemented in C# for .NET Core Current status of this PR: * tested and targeted for .NET Core 2.1 * all functionality is either on par or improved compared to the python version * compatibility with current bot.db should be preserved in all upgrade scenarios * some bot management commands were changed (now under !sudo bot) * standard help generator for the new discord client is ... different; compatibility with old format could be restored through custom formatter if needed * everything has been split in more loosely tied components for easier extensibility and maintenance * log parsing has been rewritten and should work ~2x as fast 2018-07-19 12:42:48 +00:00			* `$ cd CompatBot`
Update README.md 2019-03-01 17:52:52 +00:00			* `$ dotnet run -c Release`
update readme 2019-02-02 15:03:51 +00:00
			`External resources that need manual updates`
			`-------------------------------------------`
			`* [Unicode confusables](http://www.unicode.org/Public/security/latest/confusables.txt) gzipped, for Homoglyph checks`
some docs 2019-03-29 14:51:44 +00:00			`* Optionally [Redump disc key database](http://redump.org/downloads/) in text format (requires membership)`