Config

Important

Wiki has been moved

You can find it at https://ovr.andre601.ch/config

Config.yml

The config.yml of OneVersionRemake has a lot of settings for you to use.

This page tries to explain each option as detailed as possible!

Contents

• Settings
  • UpdateVersions
  • VersionsUrl
• Protocol
  • Versions
  • LogDenial
  • MajorOnly
  • Blacklist
• Messages
  • Formatting
    • Basic Formatting
    • Advanced Formatting
    • Not supported Options
  • PlayerCount
  • Kick
  • Hover
  • Motd

Settings

Main Settings of the plugin that do not fit any of the other sections.

UpdateVersions

Type: Boolean
Default:

UpdateVersions: true

This options sets whether OneVersionRemake should download the latest versions.json or not when enabling.

VersionsUrl

Type: String
Default:

VersionsUrl: 'https://www.andre601.ch/oneversionremake/protocol_versions.json'

With this option can you change the URL from which OneVersionRemake will retrieve the current protocol versions.

When changing the URL, make sure the following things are valid:

• The URL returns Content-Type: application/json
• The returned content is valid JSON
• [Since v3.11.0]: The returned content contains a file_version key with an integer value.

Protocol

This section of the config contains the main settings used for things like determining what versions are allowed on the Network.

Versions

Type: List (Integer)
Default:

Versions: []

This List is used to set what MC Versions are allowed to join the Network.
Note that instead of the actual MC version (i.e. 1.15) do you instead set the Protocol Version of it.

Protocol Versions are, in most simplistic terms, unique numbers to determine what MC version is joining the network.

You can find a full list of Protocol Versions on the official Minecraft Wiki: https://minecraft.gamepedia.com/Protocol_version#Java_Edition_2

Note that only a selected list of versions is supported by the {version} and {userVersion} placeholders and will be turned into readable MC versions.
A list of supported Versions can be found in the Supported Protocols page of this wiki.

LogDenial

Type: Boolean
Default:

LogDenial: true

This setting allows you to choose, if OneVersionRemake should log denied logins or not.

When this is set to true will any attempted join with a not supported version be denied and the following message printed into the console:

[OneVersionRemake] Denied login for Player <player> with MC version <mcversion> (Protocol version <protocol>)

MajorOnly

Type: Boolean
Default:

MajorOnly: false

When this option is set to true, will the {version} placeholder only display the Major MC versions of the defined Protocol versions.

Example:

• Setup:

  Versions:
  - 477
  - 480
  - 485
  - 490
  - 498
  - 573
  - 575
  - 578
  - 735
  - 736
  - 751
  - 753
  - 754

  With MajorOnly set to false:

  1.14, 1.14.2, 1.14.3, 1.14.4, 1.15, 1.15.1, 1.15.2, 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.5
  

  With MajorOnly set to true:

  1.14.x, 1.15.x, 1.16.x
  

Blacklist

Type: Boolean Default:

Blacklist: false

When this option is set to true, will OneVersionRemake treat the Protocol List as a blacklist, meaning only players not having any of the listed versions may join.

Messages

The Messages section allows you to define the different messages displayed when a player either joins or views a server with an unsupported version.

Formatting

OneVersionRemake uses the MiniMessage Add-on from Kyori Adventure to provide basic but also advanced color and text formatting options.
Depending on the config option are either only basic or advanced options supported.

• Basic Formatting

  Colors

  Option 1	Option 2
  <aqua>	<color:aqua>
  <black>	<color:black>
  <blue>	<color:blue>
  <dark_aqua>	<color:dark_aqua>
  <dark_blue>	<color:dark_blue>
  <dark_gray>/<dark_grey>	<color:dark_gray>/<color:dark_grey>
  <dark_green>	<color:dark_green>
  <dark_purple>	<color:dark_purple>
  <dark_red>	<color:dark_red>
  <gold>	<color:gold>
  <gray>	<color:gray>
  <green>	<color:green>
  <light_purple>	<color:light_purple>
  <red>	<color:red>
  <white>	<color:white>
  <yellow>	<color:yellow>

  Formatting

  Name	Alias
  <bold>	<b>
  <italic>	<em>
  	<i>
  <obfuscated>	<obf>
  <reset>	<r>
  <strikethrough>	<st>
  <underlined>

• Advanced Formatting

  Includes Basic Formatting but also some more advanced options:

  Option	Format
  RGB Colors	<#rrggbb>
  	<color:#rrggbb>
  Gradients*	<gradient:#rrggbb:#rrggbb>
  Keybind	<key:_key_>
  Rainbow	<rainbow>
  Translatable**	<lang:_key_>
  	<lang:_key_:_optional1_:...>

  *Also supports Color Names.
  **_optionalX_ will be used to replace placeholders in the returned text.

• Not supported options

  These options are not supported in any of the messages.

  Option	Reason
  <click:_action_:_value_>	Will render but won't perform anything on click.
  <font:_name_>	Requires an active resource pack for the client to display the font.
  <hover:_action_:_value_>	Will render but won't show anything on hover.
  <insert:_text_>	Will render but not perform on click.

---

PlayerCount

Type: String
Default:

PlayerCount: '<red>Minecraft {version}'

Supported Formatting: Basic

Changes the text that usually displays the player count (<online>/<total>).
You can set this to an empty String (PlayerCount: '') to not alter the text or to just a color/formatting code (PlayerCount: '<red>') to hide it completely!

Kick

Type: List (String)
Default:

Kick:
- '<red>You are using an unsupported version of Minecraft ({userVersion})!'
- '<red>This server supports the following Versions:'
- '<gray>{version}'
- ''
- '<red>Please change your Version and try again.' 

Supported Formatting: Advanced

The text to display when the Player gets kicked for using an unsupported MC version.

This setting can NOT be disabled and will default to the following text when set to an empty list:

<red>This Server is running MC {version}! Please change your client version.

Hover

Type: List (String)
Default:

Hover:
- '<red>You are using an unsupported version of Minecraft ({userVersion})!'
- '<red>Please change your version to {version}.' 

Supported Formatting: Basic

This is the text displayed when the player hovers with his cursor over the Player Count.

This text usually displays (random) online players on the network, but we can use it to display this custom text instead.
You can set it to an empty list (Hover: []) to not change the Players shown.

Motd

Type: List (String)
Default:

Motd:
- '<red>Unsupported Minecraft Version {userVersion}'
- '<red>Please use <gray>{version}</gray>.'

Supported Formatting: Advanced

This text is shown in the MOTD when the server is displayed in the Server list of the client.

You can set this to an empty list (Motd: []) to not change the MOTD displayed.
Only the first 2 lines will be used from the list.