Giter VIP home page Giter VIP logo

source-chat-relay's Introduction

Source Chat Relay

A self-hosted Discord <=> Source game relay

Features

  • Bidirectional - You can receive/send on both Discord and game server side!
  • Channel - Get creative! With the ability to specify receive/send channels, you can even send messages to other game servers, not only to Discord!
  • Ease of use - Setup is incrediblily easy with Discord bot commands and simple config files
  • Reliable - Upon disconnect, game servers will attempt to reconnect at a fixed interval

Requirement

  • A MySQL server
  • A game server with the socket extension
  • A server to host the relay server on
  • A Discord bot token

Getting started

  1. Head over to Releases and download the latest package for your operating system

  2. Relay Server

    1. Upload the binary to the server
    2. Configure config.toml.example and rename it to config.toml
    3. Start it by running ./server
  3. Game server

    1. Upload the plugin to addons/sourcemod/plugins
    2. Load the plugin
    3. Configure the config at cfg/sourcemod/Source-Chat-Relay.cfg with the host/port of the relay server
    4. Reload the plugin
  4. If all goes properly, the client should connect to the relay server and authenticate itself

Bot Commands

Before any clients can send messages, you must set the receive/send channels on them

  • r/receivechannel #Channel/EntityID Channel
  • r/sendchannel #Channel/EntityID Channel
  • r/entities ?channel/server

Credits

  • Ron for being a human linter

License

This project is licensed under GPL 3.0

source-chat-relay's People

Contributors

ronmelkhior avatar rumblefrog avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.