Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.52 KB

Building.md

File metadata and controls

47 lines (30 loc) · 1.52 KB
Raw

Building SCPDiscord

Dependencies

  • dotnet-sdk (8.0)
  • mono
  • protobuf

Building the plugin

Via Rider or Visual Studio

Load the SCPDiscordPlugin project and build using the controls in the IDE.

Note: Rider doesn't support mixing mono and dotnet projects in the same solution so you have to open the projects individually, not the solution.

Manually

Enter the SCPDiscord plugin directory and use the following command in order to build the plugin:

msbuild SCPDiscordPlugin.csproj -restore

Building the bot

Via Rider or Visual Studio

Load the SCPDiscordBot project and build using the controls in the IDE.

Manually

Enter the SCPDiscord bot directory and use the following commands:

dotnet build --output bin/linux-x64 --configuration Release --runtime linux-x64
dotnet build --output bin/win-x64 --configuration Release --runtime win-x64

Generating the network interface

This section is only needed if you need to edit the network traffic between the plugin and bot.

The bot and plugin communicate using protobuf messages. These messages are constructed from protobuf schemas located in the schema directory which are then generated into the bot and plugin's interface directories.

If you edit the schema files you need to run the following command in the schema directory to generate the interface classes:

protoc --csharp_out "../SCPDiscordBot/Interface" --csharp_out "../SCPDiscordPlugin/Interface" --proto_path . *.proto ./BotToPlugin/*.proto ./PluginToBot/*.proto