VRisingDiscordBotCompanion
A companion mod for DarkAtra's v-rising-discord-bot.
Last updated | 8 months ago |
Total downloads | 495 |
Total rating | 0 |
Categories | Server Mods Gloomrot Update |
Dependency string | DarkAtra-VRisingDiscordBotCompanion-0.4.0 |
Dependants | 0 other packages depend on this package |
This mod requires the following mods to function
BepInEx-BepInExPack_V_Rising
BepInEx pack for V Rising. Preconfigured and includes Unity Base DLLs.
Preferred version: 1.668.5README
V Rising Discord Bot Companion
This BepInEx plugin for V Rising Servers adds additional http endpoints to the server's ServerWebAPISystem
. This
allows you to expose additional information about players, such as the current gear level. Intended to be used
with v-rising-discord-bot.
It is recommended to not expose the server's api port to the internet.
Support
If you have questions or need support, feel free to join this discord server.
Endpoints
/v-rising-discord-bot/characters
Returns information about all characters that exist on the server. Intended to be used in conjunction with the v-rising-discord-bot to display the gear level for all characters.
Example Response
HTTP/1.1 200 OK
Transfer-Encoding: chunked
Content-Type: application/json
[
{
"name": "Atra",
"gearLevel": 83,
"clan": "Test",
"killedVBloods": [
"FOREST_WOLF",
"BANDIT_STONEBREAKER"
]
},
{
"name": "Socium",
"gearLevel": 84,
"killedVBloods": []
}
]
/v-rising-discord-bot/player-activities
Returns a list of connect and disconnect events for the last 10 minutes. Intended to be used in conjunction with the v-rising-discord-bot to log connect and disconnect messages on discord.
Note that this is not persistent across server restarts.
Example Response
HTTP/1.1 200 OK
Transfer-Encoding: chunked
Content-Type: application/json
[
{
"type": "CONNECTED",
"playerName": "Atra",
"occurred": "2023-01-01T00:00:00Z"
},
{
"type": "DISCONNECTED",
"playerName": "Atra",
"occurred": "2023-01-01T01:00:00Z"
}
]
/v-rising-discord-bot/pvp-kills
Returns the most recent pvp kills. Intended to be used in conjunction with the v-rising-discord-bot to display a kill feed on discord.
Note that this is not persistent across server restarts.
Example Response
HTTP/1.1 200 OK
Transfer-Encoding: chunked
Content-Type: application/json
[
{
"killer": {
"name": "Atra",
"gearLevel": 71
},
"victim": {
"name": "Testi",
"gearLevel": 11
},
"occurred": "2023-01-01T00:00:00Z"
}
]
Installing this BepInEx plugin on your V Rising Server
Please note that modding support for V Rising Gloomrot is still experimental. Proceed at your own risk.
- Validate that the server has it's api enabled and a port configured. It is not recommended to expose the api port to the internet.
- Install the latest version of BepInEx on your Gloomrot V Rising server.
- Download the v-rising-discord-bot-companion.dll or build it yourself by
cloning this repository and running
dotnet build
. - Download the Bloodstone.dll.
- Move all dlls into your server's BepInEx
plugins
folder. - Start the server and test if the new endpoint is functional by executing the following command in the
terminal:
curl http://<your-server-hostname-here>:<your-api-port-here>/v-rising-discord-bot/characters
. Validate that the returned status code is 200 as soon as the server has fully started.