Files
archived-discord-bot/README.md
13xforever 7fd7d09973 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-20 09:22:28 +02:00

30 lines
1.1 KiB
Markdown

RPCS3 Compatibility Bot reimplemented in C# for .NET Core
=========================================================
Development Requirements
------------------------
* [.NET Core 2.1 SDK](https://www.microsoft.com/net/download/windows) or newer
* Any text editor, but Visual Studio 2017 or Visual Studio Code is recommended
Runtime Requirements
--------------------
* [.NET Core 2.1 Runtime](https://www.microsoft.com/net/download/windows) or newer for compiled version
* [.NET Core 2.1 SDK](https://www.microsoft.com/net/download/windows) or newer to run from sources
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 NAME`
* `$ cd ..`
* `$ cd CompatBot`
* `$ dotnet run [token]`
How to Run in Production
------------------------
* Change configuration if needed (probably just token)
* Put `bot.db` in `CompatBot/`
* `$ cd CompatBot`
* `$ dotnet run -c Release [token]`