oliverbooth/VPLink
oliverbooth
/
VPLink
mirror of https://github.com/oliverbooth/VPLink
1
0
Fork 0
Code Issues Wiki
VP <-> Discord chat relay bot. https://virtualparadise.org
77 Commits 1 Branch 14 Tags 192 KiB
C# 98.7%
Dockerfile 1.3%
Go to file
Oliver Booth 5a97cfd00e
ci: add workflow_dispatch trigger 		2023-08-28 01:42:23 +01:00
.github ci: add workflow_dispatch trigger 2023-08-28 01:42:23 +01:00
VPLink chore: bump to 1.3.2 2023-08-28 01:35:33 +01:00
VPLink.Common feat: render relative timestamps the way Discord does it 2023-08-27 21:44:56 +01:00
VPLink.Tests chore: drop Microsoft.NET.Test.Sdk to 17.5.0 2023-08-28 01:09:34 +01:00
.dockerignore feat: initial commit 2023-08-22 14:57:18 +01:00
.gitignore feat: initial commit 2023-08-22 14:57:18 +01:00
CONTRIBUTING.md docs: add contrib guidelines 2023-08-26 14:20:22 +01:00
LICENSE.md docs: add MIT license 2023-08-26 14:20:29 +01:00
README.md docs: add a more fleshed-out README 2023-08-26 14:41:05 +01:00
VPLink.sln chore: add docker-compose to sln 2023-08-28 00:49:13 +01:00
banner.png docs: add a more fleshed-out README 2023-08-26 14:41:05 +01:00
config.example.toml docs: add a more fleshed-out README 2023-08-26 14:41:05 +01:00
docker-compose.yml refactor!: rename to VPLink 2023-08-26 12:50:06 +01:00
global.json chore: rollForward to latestMajor 2023-08-26 18:02:42 +01:00

README.md

GitHub Workflow Status GitHub Issues GitHub release MIT License

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

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.