Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mefrreex/vk-rcon-bot
A simple Rcon Bot for VK
https://github.com/mefrreex/vk-rcon-bot
bot java java-sdk kotlin rcon rcon-bot vk vk-api vk-bot vk-java-sdk vk-rcon-bot vk-sdk vkbot vkcom vkontakte
Last synced: 3 months ago
JSON representation
A simple Rcon Bot for VK
- Host: GitHub
- URL: https://github.com/mefrreex/vk-rcon-bot
- Owner: MEFRREEX
- License: gpl-3.0
- Created: 2023-02-26T09:30:44.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-03T12:47:40.000Z (3 months ago)
- Last Synced: 2024-10-09T18:21:14.571Z (3 months ago)
- Topics: bot, java, java-sdk, kotlin, rcon, rcon-bot, vk, vk-api, vk-bot, vk-java-sdk, vk-rcon-bot, vk-sdk, vkbot, vkcom, vkontakte
- Language: Kotlin
- Homepage:
- Size: 289 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vk-Rcon-Bot
A simple bot for sending commands to a Minecraft server via RCON through the VK platform.
## ๐ Features
- Sends RCON commands to a server directly from VK messages.
- Easy setup and configuration.
- Lightweight and simple to use.
- **Multilingual support**: The bot supports multiple languages, with easy customization of all messages.
- **Command prefix**: Ability to specify a custom prefix for commands.
- **Quick commands**: Add predefined quick commands for frequent actions.
- **Command blocking**: Option to block specific unwanted commands from being executed.
## ๐ฎ Running the Bot
1. Download the latest release of the bot.
2. Run the following command to start the bot:
```bash
java -jar VkRconBot-.jar
```
## โ๏ธ Configuration
After the first run of the bot, a configuration file config.yml will be generated. You will need to edit this file before the bot can function properly.
```yaml
# Available languages: eng (English), rus (ะ ัััะบะธะน)
language: "rus"
# VK settings
vk:
groupId: 123 # VK group Id
accessToken: "token" # VK group token
# RCON settings
rcon:
host: "localhost" # RCON address
port: 19132 # RCON port
password: "password" # RCON password
# Command settings
commands:
# A character before the command to send the command. For example '/'.
# Leave blank if not required.
prefix: '/'
# Fast commands
# (Displayed when โStartโ, โRconโ is entered)
fast-commands: ["ver", "status", "stop"]
# Blocked commands
blocked-commands: ["stop"]
```
## ๐ Building the JAR File
To build the project from source:
1. Clone the repository:
```bash
git clone https://github.com/MEFRREEX/Vk-Rcon-Bot.git
```
2. Navigate to the project directory:
```bash
cd Vk-Rcon-Bot
```
3. Build the JAR file using Gradle:
```bash
gradle build
```
## ๐ Dependencies
The project uses the following libraries:
- [Vk-Java-Sdk](https://github.com/VKCOM/vk-java-sdk) - for VK API integration.
- [Configuration](https://github.com/MEFRREEX/Configuration) - for managing configuration files.