Skip to content

Setup Guide

Martin edited this page Aug 6, 2021 · 1 revision

Installation

  1. Open your Velocity Proxy plugins folder
  2. Put the VexelCore-Proxy .jar file into the plugins folder.
  3. Stop the proxy if it is running, then start it.

You should see the message "All configs have been loaded!" from VexelCore in the console.

Configuring VexelCore (Proxy)

Navigate to the plugins folder for your proxy. There should be a folder called "vexelcore". Inside, there should be a "config.toml" file. That is the file used to control and customize VexelCore.

Features

VexelCore is modular. This means you can enable/disable and customize the majority of the plugin. The [features] section accepts booleans (true/false).

Custom Commands

Allows you to create aliases for commands that players will execute on the proxy or server. As this plugin is running on the proxy, the command(s) will work on any server connected to the proxy.

Type

Type is the type of custom command. Options are playerProxyExecute and playerServerExecute. More types are planned to come out soon.

newCommand

The newCommand option is for playerProxyExecute and playerServerExecute. It is the command the player will type.

execute

The execute option is for playerProxyExecute and playerServerExecute. It is the command that the proxy or server thinks the player executed.

passArgs

The passArgs option is for playerProxyExecute and playerServerExecute. This allows arguments of a command to be passed in addition to the value of execute.

Example

customCommand = [
    { type = "playerProxyExecute", newCommand = "hub", execute = "server hub", passArgs = "no" },
    { type = "playerProxyExecute", newCommand = "survival", execute = "server survival", passArgs = "no" },
    { type = "playerServerExecute", newCommand = "helpplz", execute = "help", passArgs = "yes" },
]
Clone this wiki locally