VPLink/README.md

About

VPLink is a simple and customisable bot for both Discord and Virtual Paradise, which bridges chat messages between a designated Discord channel, and the world where the bot is running. It is written in C# and uses the Discord.NET library, as well as a wrapper for the Virtual Paradise SDK that I wrote myself.

Installation

Prerequisites

• Visual Studio 2022 (or later)
• .NET 7.0 SDK (or later)
• A Virtual Paradise user account
• A Discord user account, and a bot application

Setup (docker-compose)

1. Clone the repository to your local machine.
2. Edit the docker-compose.yml file to your needs, including validating the mount paths.
3. /app/data (relative to the container) must contain a config.toml file with the fields populated, see the example config file for the available fields.
4. Run docker-compose up -d to start the bot.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please see the contributing guidelines for more information.

License

VPlink is licensed under the MIT License. See the LICENSE.md file for more information.