Skip to content

Home

Jump to bottom
Mike Kuoushi edited this page Mar 31, 2022 · 8 revisions

Welcome to the ServUO-Matterbridge wiki!

This script bridges chat and world talk from a ServUO server to a matterbridge instance. Matterbridge handles sending messages to and from a large number of chat services, meaning it will allow you to use this script to relay chat to practically anywhere you wish without having to write any actual code.

Requirements

This script requires the following:

  1. The Refit library to handle the API calls.
  2. A working matterbridge installation to function.

Installation

To install this script, you will need to install the appropriate scripts and requirements in your ServUO server, as well as set up a separate instance of Matterbridge. Read on for a quick overview of how to get this script going.

ServUO

Copy the following files to your Scripts/Custom folder.

  • Matterbridge.cs
  • MatterbridgeConfig.cfg

MatterbridgeConfig.cfg

Open the MatterbridgeConfig.cfg file and enter the relevant information, then save.

Some notes on the fields inside of this config file.

TargetGateway

The TargetGateway field is where you will set which Matterbridge gateways you'd like the server to send messages to. If you have more than one gateway, you can enter them all on this line separated by commas. Do not put any spaces around the commas.

Ex.) Two Gateways (servuo-gateway & servuo-log)

TargetGateway=servuo-gateway,servuo-log

MessageFormat

This field will allow you to describe exactly how your message will look when it is sent to Matterbridge.

Server Scripts

Open your Scripts/Scripts.csproj file in Notepad, then add the following lines like below:

Original:

  <PropertyGroup>
      <DefineConstants>NEWTIMERS;ServUO</DefineConstants>
  </PropertyGroup>

  <ItemGroup>
      <ProjectReference Include="..\Server\Server.csproj" />
  </ItemGroup>

New:

    <PropertyGroup>
        <DefineConstants>NEWTIMERS;ServUO</DefineConstants>
    </PropertyGroup>

    <ItemGroup>
        <PackageReference Include="Refit" Version="6.3.2" />
    </ItemGroup>

    <ItemGroup>
        <ProjectReference Include="..\Server\Server.csproj" />
    </ItemGroup>

Recompile your ServUO server. It should now be ready to relay text to a working matterbridge instance.

matterbridge

You will need to download the latest release of matterbridge, then create a matterbridge.toml file to tell it where to relay text.

A sample matterbridge.toml file is included in this library, but you will need to change it to fit your needs. More information on matterbridge and setting up your own toml file can be found here.

Clone this wiki locally