Skip to content

Building

Jump to bottom
shmitzas edited this page Feb 9, 2026 · 1 revision

🔨 Building from Source

This guide will help you build the MixScrims plugin from source code.

Prerequisites

Before you start, make sure you have:

  • Git - To clone the repository (Download Git)
  • .NET 10 SDK - To build the project (Download .NET)
  • Code Editor - Visual Studio, Rider, or VS Code (optional, but helpful)

Quick Start

1. Get the Code

Open your terminal and run:

git clone https://github.com/Shmitzas/MixScrims-SwiftlyS2.git
cd MixScrims-SwiftlyS2

This downloads the project to your computer.

2. Build the Project

dotnet build -c Release

This compiles the code into executable files. The -c Release flag creates an optimized version.

3. Publish the Plugin

dotnet publish -c Release

This creates the final plugin files ready to use on your server.

Where to Find Your Files

After publishing, you'll find your plugin files at:

Main plugin folder:

MixScrims/build/publish/MixScrims/

What's included:

  • Plugin DLL files in the main folder
  • Server configs in cfg/mixscrims/
  • Translation files in resources/translations/
  • API contract in resources/exports/MixScrims.Contract.dll

Development Setup

Working with the Code

  1. Open the project in your preferred editor:

    • Visual Studio: Open MixScrims-SwiftlyS2.sln
    • VS Code: Open the folder
    • Rider: Open the solution file

  2. Make your changes to the code

  3. Test your changes by building: dotnet build

  4. Publish when ready: dotnet publish -c Release

Hot Reload Support

Swiftly supports hot reload, which means you can make changes and see them without restarting the server completely. Just rebuild and the changes will load.

Common Issues

"dotnet command not found"

  • Make sure .NET 10 SDK is installed
  • Restart your terminal after installing

Build errors

  • Make sure you're in the project folder
  • Check that all dependencies are restored: dotnet restore

Need help?

Next Steps

After building:

  1. Copy the MixScrims folder from build/publish/ to your server's Swiftly plugins directory
  2. Configure the plugin (see Configuration)
  3. Restart your server

Happy coding! 🚀

Clone this wiki locally