From d7b7f16fbb93f9857d6344c6296a0a51d7680d69 Mon Sep 17 00:00:00 2001 From: Andre601 Date: Fri, 22 Nov 2024 20:23:20 +0100 Subject: [PATCH] Move Wiki to GitHub Pages --- .github/workflows/wiki.yml | 53 ++- docs/assets/css/custom.css | 3 + .../ovr.png => docs/assets/img/favicon.png | Bin docs/assets/js/version-table-gen.js | 74 +++++ docs/config.md | 304 ++++++++++++++++++ docs/index.md | 21 ++ docs/protocols.md | 28 ++ mkdocs.yml | 81 +++++ requirements.txt | 1 + wiki/Config.md | 281 ---------------- wiki/Home.md | 7 - wiki/Supported-Protocols.md | 59 ---- wiki/_Footer.md | 19 -- wiki/_Sidebar.md | 5 - 14 files changed, 554 insertions(+), 382 deletions(-) create mode 100644 docs/assets/css/custom.css rename wiki/images/ovr.png => docs/assets/img/favicon.png (100%) create mode 100644 docs/assets/js/version-table-gen.js create mode 100644 docs/config.md create mode 100644 docs/index.md create mode 100644 docs/protocols.md create mode 100644 mkdocs.yml create mode 100644 requirements.txt delete mode 100644 wiki/Config.md delete mode 100644 wiki/Home.md delete mode 100644 wiki/Supported-Protocols.md delete mode 100644 wiki/_Footer.md delete mode 100644 wiki/_Sidebar.md diff --git a/.github/workflows/wiki.yml b/.github/workflows/wiki.yml index 2eeed9b..0eb89ff 100644 --- a/.github/workflows/wiki.yml +++ b/.github/workflows/wiki.yml @@ -1,20 +1,51 @@ -name: Update Wiki +name: Publish wiki on: workflow_dispatch: push: paths: - - 'wiki/**' - branches: - - 'master' + - '.github/workflows/wiki.yml' + - 'docs/**' + - 'mkdocs.yml' + - 'requirements.txt' + +permissions: + actions: read + contents: read + pages: write + id-token: write + +concurrency: + group: github-pages + cancel-in-progress: false jobs: - update: + buildSite: runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} steps: - - uses: actions/checkout@v4 - - uses: SwiftDocOrg/github-wiki-publish-action@v1 - with: - path: 'wiki' - env: - GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.PAT }} + - name: Checkout Repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Setup Python 3.x + uses: actions/setup-python@v5 + with: + python-version: 3.x + - name: Update Pip and install dependencies + run: | + python -m pip install -U pip + pip install -r requirements.txt + - name: Build Site + run: mkdocs build + - name: Configure GitHub Pages + uses: actions/configure-pages@v4 + - name: Upload Pages Artifact + uses: actions/upload-pages-artifact@v3 + with: + path: 'site/' + - name: Deploy to GitHub Pages + uses: actions/deploy-pages@v3 + id: deployment \ No newline at end of file diff --git a/docs/assets/css/custom.css b/docs/assets/css/custom.css new file mode 100644 index 0000000..247f1f7 --- /dev/null +++ b/docs/assets/css/custom.css @@ -0,0 +1,3 @@ +.md-header__button.md-logo img, .md-header__button.md-logo svg { + height: 3rem; +} \ No newline at end of file diff --git a/wiki/images/ovr.png b/docs/assets/img/favicon.png similarity index 100% rename from wiki/images/ovr.png rename to docs/assets/img/favicon.png diff --git a/docs/assets/js/version-table-gen.js b/docs/assets/js/version-table-gen.js new file mode 100644 index 0000000..37fea83 --- /dev/null +++ b/docs/assets/js/version-table-gen.js @@ -0,0 +1,74 @@ +document$.subscribe(async () => { + const url = `https://api.allorigins.win/raw?url=${encodeURIComponent('https://andre601.ch/oneversionremake/protocol_versions.json')}`; + + const versions_table = document.querySelector('[data-md-component="versions-table"]'); + + const headerText = ['Protocol', 'Version', 'Major']; + + function createTable(data) { + const table = document.createElement("table"); + const tableHead = document.createElement("thead"); + const tableBody = document.createElement("tbody"); + + if(tableHead === null || tableBody === null) + return; + + const headRow = document.createElement("tr"); + for(let i = 0; i < 3; i++) { + const cell = document.createElement("th"); + const text = document.createTextNode(`${headerText[`${i}`]}`); + + cell.appendChild(text); + headRow.appendChild(cell); + } + + tableHead.appendChild(headRow); + + console.log(data.protocols) + + for(i in data.protocols){ + const value = data.protocols[i]; + const row = document.createElement("tr"); + + const protocol = document.createElement("td"); + const protocolText = document.createTextNode(value.protocol) + + const version = document.createElement("td"); + const versionText = document.createTextNode(value.name) + + const major = document.createElement("td"); + const majorText = document.createTextNode(value.major) + + protocol.appendChild(protocolText); + version.appendChild(versionText); + major.appendChild(majorText); + + row.appendChild(protocol); + row.appendChild(version); + row.appendChild(major); + + tableBody.appendChild(row); + } + + table.appendChild(tableHead); + table.appendChild(tableBody); + + versions_table.appendChild(table); + } + + async function fetchData() { + const data = await fetch(`${url}`).then(_ => _.json()); + + __md_set("__versions_data", data, sessionStorage); + createTable(data); + } + + if(document.querySelector('[data-md-component="versions-table"]')) { + const cached = __md_get("__versions_data", sessionStorage); + if(cached != null) { + createTable(cached); + } else { + fetchData(); + } + } +}) \ No newline at end of file diff --git a/docs/config.md b/docs/config.md new file mode 100644 index 0000000..54d225f --- /dev/null +++ b/docs/config.md @@ -0,0 +1,304 @@ +# Config.yml + +OneVersionRemake's `config.yml` offers various options to configure. This page explains them in detail. + +## Contents + +- [Settings](#settings) + - [UpdateVersions](#updateversions) + - [VersionsUrl](#versionsurl) +- [Protocol](#protocol) + - [Versions](#versions) + - [LogDenial](#logdenial) + - [MajorOnly](#majoronly) + - [Blacklist](#blacklist) +- [Messages](#messages) + - [Supported Formatting](#supported-formatting) + - [Available Placeholders](#available-placeholders) + - [PlayerCount](#playercount) + - [Kick](#kick) + - [Hover](#hover) + - [Motd](#motd) + +## Settings + +Main settings of the plugin that don't fit any of the other sections. + +### UpdateVersions + +/// info | +**Type:** `Boolean` +**Default:** +```yaml +Settings: + UpdateVersions: true +``` +/// + +Wether OneVersionRemake should update the versions file when enabling itself. +Only updates should there be a newer version at the source. + +### VersionsUrl + +/// info | +**Type:** `String` +**Default:** +```yaml +Settings: + VersionsUrl: 'https://www.andre601.ch/oneversionremake/protocol_versions.json' +``` +/// + +The URL OneVersionRemake should use to check for an updated file. +Should you change the URL, make sure the new URL follows these requirements: + +- Content-type returned is `application/json` +- The returned Content is a valid JSON file +- [[Since v3.11.0](https://github.com/Andre601/OneVersionRemake/releases/tag/v3.11.0)] The file contains a `file_version` Number option and a `protocols` Array. + +## Protocol + +Protocol-related options can be found here. This also includes the option to set what Client versions should (not) join your Server. + +### Versions + +/// info | +**Type:** `List[Integer]` +**Default:** +```yaml +Protocols: + Versions: [] +``` +/// + +/// note +You need to use protocol versions and not the MC version. +As an example, to support all 1.21 versions (State: 22nd of November 2024) will you need to use the values `767` and `768`. + +A full list of all available Protocol Versions can be found at https://minecraft.wiki/w/Protocol_version#Java_Edition + +Be aware that only a selected number of versions may be translatable into readable MC versions by the plugin. Please see the [Supported Protocols](protocols.md) page for more. +/// + +Sets the list of allowed client versions that can join the Server. +Should [Blacklist](#blacklist) be enabled will the list be treated as Client versions that should not join your Server. + +### LogDenial + +/// info | +**Type:** `Boolean` +**Default:** +```yaml +Protocols: + LogDenial: true +``` +/// + +Wether OneVersionRemake should log denied joins for players with unsupported Protocol Versions. + +When enabled will the plugin post the following message for every denied Player: +``` +[OneVersionRemake] Denied login for Player {player} with MC version {version} (Protocol version {protocol}) +``` + +### MajorOnly + +/// info | +**Type:** `Boolean` +**Default:** +```yaml +Protocols: + MajorOnly: false +``` +/// + +Wether OneVersionRemake should only display the major version for a set of protocols in the `{version}` placeholder. + +/// details | Example + type: example + +//// tab | MajorOnly enabled +**Setup:** +```yaml +Protocols: + Versions: + - 477 + - 480 + - 485 + - 490 + - 498 + - 573 + - 575 + - 578 + - 735 + - 736 + - 751 + - 753 + - 754 + MajorOnly: true +``` + +**`{version}` Output:** +``` +1.14.x, 1.15.x, 1.16.x +``` +//// + +//// tab | MajorOnly disabled +**Setup:** +```yaml +Protocols: + Versions: + - 477 + - 480 + - 485 + - 490 + - 498 + - 573 + - 575 + - 578 + - 735 + - 736 + - 751 + - 753 + - 754 + MajorOnly: false +``` + +**`{version}` Output:** +``` +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 +``` +//// +/// + +### Blacklist + +/// info | +**Type:** `Boolean` +**Default:** +```yaml +Protocols: + Blacklist: false +``` +/// + +Wether the Provided Protocol List should be treated as a Blacklist. +When enabled will OneVersionRemake deny access to your Server should the Player use any of the versions set. + +## Messages + +The Messages section contains all the options for customizing the different texts displayed to a player with a denied version. + +### Supported Formatting + +Please note that OneVersionRemake uses `MiniMessage` for formatting, meaning that instead of color and formatting codes such as `&1` and `&l` would you use `` and `` respectively. +This choice was made deliberately, as MiniMessage allows a much more complex formatting without sacrificing readability in the process (See the ugly aproach of making gradients with color codes). + +As a final note, be aware that the following options **cannot** be used, no matter where they are used: + +- Click actions (``). They won't perform anything on click. +- Custom Fonts (``). May work if the client already has the resource pack loaded. +- Hover text (``). Won't display anything on hover. +- Text insertion (``). Won't do anything on click. + +### Available Placeholders + +OneVersionRemake provides the following Placeholders: + +| Placeholder | Description | +|-----------------|----------------------------------------------------------------------------------------------------------------------------| +| `{version}` | Gets converted to a comma-separated list of MC versions based on the [protocol versions](#versions) you set. | +| | Should [MajorOnly](#majoronly) be true will only the major versions be listed. | +| `{userVersion}` | Displays the Player's MC version. Should the player use a version not in OVR's Version JSON file, will `???` be displayed. | + +### PlayerCount + +/// info | +**Type:** `String` +**Default:** +```yaml +Messages: + PlayerCount: 'Minecraft {version}' +``` +**Supported formatting:** + +- Basic colors (``, ``, etc.) +- Formatting +/// + +Modifies the text that usually displays the online and total number of players for the server. +Set this to an empty String (`#!yaml PlayerCount: ''`) to not modify the Player count. + +You can also set it to just a color/formatting code (i.e. `#!yaml PlayerCount: ''`) to hide the player count. + +### Kick + +/// info | +**Type:** `List[String]` +**Default:** +```yaml +Messages: + Kick: + - 'You are using an unsupported version of Minecraft ({userVersion})!' + - 'This server supports the following Version(s):' + - '{version}' + - '' + - 'Please change your Minecraft Version and try again.' +``` +**Supported formatting:** + +- Hex Colors (`<#rrggbb>`, includes ``) +- Basic colors (``, ``, etc.) +- Formatting (``, ``, etc.) +/// + +Sets the Message to display when OneVersionRemake kicks the player (Denies the join). + +Note that this option can **not** be disabled and will default to the following kick message when removed or set empty: +``` +This Server is running MC {version}! Please change your client version. +``` + +### Hover + +/// info | +**Type:** `List[String]` +**Default:** +```yaml +Messages: + Hover: + - 'You are using an unsupported version of Minecraft ({userVersion})!' + - 'Please change your version to {version}.' +``` +**Supported formatting:** + +- Basic colors (``, ``, etc.) +- Formatting (``, ``, etc.) +/// + +This sets the text that is displayed when the player hovers over the Player count, which usually displays players online on the server. +Set this to an empty List (`#!yaml Hover: []`) to not alter the Hover. + +### Motd + +/// info | +**Type:** `List[String]` +**Default:** +```yaml +Messages: + Motd: + - 'Unsupported Minecraft Version {userVersion}' + - 'Please use {version}.' +``` +**Supported formatting:** + +- Hex Colors (`<#rrggbb>`, includes ``) +- Basic colors (``, ``, etc.) +- Formatting (``, ``, etc.) +/// + +Sets the text to display in the Server's MOTD. +Only the first two lines are considered and every additional one will be ignored. + +Set to an empty List (`#!yaml Motd: []`) to not modify the MOTD. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..2cef008 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,21 @@ +# Welcome to the OneVersionRemake Wiki + +OneVersionRemake is a plugin that allows you to allow/block specific Minecraft versions from joining your servers, displaying a custom MOTD, player count, hover text and kick message. + +## Pages + +
+ +- ## [Config.yml](config.md) + + ---- + + Page covering the different options available in the config.yml of OneVersionRemake + +- ## [Supported Protocols](protocols.md) + + ---- + + A list of supported Protocol Versions that OneVersionRemake can translate into readable MC versions. + +
\ No newline at end of file diff --git a/docs/protocols.md b/docs/protocols.md new file mode 100644 index 0000000..99e2429 --- /dev/null +++ b/docs/protocols.md @@ -0,0 +1,28 @@ +# Supported Protocols + +Due to BungeeCord not offering a way to convert a player's protocol version into a readable MC version, does OneVersionRemake have its own system in place to do so. +This system is used to replace `{version}` and `{userVersion}` with readable MC versions. Former will display a comma-separated list of the configured Protocol Versions while the later will display the Player's MC version. + +To achieve this feature does OneVersionRemake pull from a JSON file which contains the necessary info. The source may differ depending on the version used: + +- `v3.11.0` and newer: https://andre601.ch/oneversionremake/protocol_versions.json ([Source](https://codeberg.org/Andre601/website/src/branch/main/docs/oneversionremake/protocol_versions.json)) +- `v3.9.0` through `v3.10.0`: https://andre601.ch/oneversionremake/versions.json ([Source](https://codeberg.org/Andre601/website/src/branch/main/docs/oneversionremake/versions.json)) +- `v3.8.2` and older: https://raw.githubusercontent.com/Andre601/OneVersionRemake/master/versions.json ([Source](https://github.com/Andre601/OneVersionRemake/blob/master/versions.json)) + +You are free to customize the file to your liking by adding or removing entries from it and you can even [change the source URL to pull from](config.md#versionsurl), just keep the structure of the file in mind. + +/// note +Any protocol version not listed in the JSON file will be displayed as `?` +/// + +## Versions + +Below is a table of supported Protocol Versions which will be translated into their respective MC version or Major MC Version for the `{version}` and `{userVersion}` placeholder. + +/// note +The table is automatically created using the latest [`protocol_versions.json` file](https://andre601.ch/oneversionremake/protocol_versions.json) as source. +Should you not see any table, make sure that you allow Javascript to be executed. Otherwise check above link for the current JSON file. +/// + +
+
\ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..ef48b77 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,81 @@ +site_name: 'OneVersionRemake' +site_description: 'Wiki of the Plugin OneVersionRemake' +site_author: 'Andre_601' +site_url: 'https://ovr.andre601.ch' + +copyright: | + Plugin and Wiki licensed under MIT License. + +docs_dir: 'docs/' + +repo_name: 'OneVersionRemake' +repo_url: 'https://github.com/Andre601/OneVersionRemake' + +theme: + name: 'material' + favicon: 'assets/img/favicon.png' + logo: 'assets/img/favicon.png' + icon: + admonition: + note: octicons/pencil-16 + abstract: octicons/checklist-16 + info: octicons/info-16 + tip: octicons/squirrel-16 + success: octicons/check-16 + question: octicons/question-16 + warning: octicons/alert-16 + failure: octicons/x-circle-16 + danger: octicons/zap-16 + bug: octicons/bug-16 + example: octicons/beaker-16 + quote: octicons/comment-16 + palette: + scheme: 'slate' + primary: 'red' + features: + - navigation.tabs + - navigation.tabs.sticky + +extra: + social: + - icon: 'simple/github' + link: 'https://github.com/Andre601/OneVersionRemake' + - icon: 'simple/modrinth' + link: 'https://modrinth.com/plugin/oneversionremake' + +extra_css: + - 'assets/css/custom.css' + +extra_javascript: + - 'assets/js/version-table-gen.js' + +nav: + - Home: index.md + - Config.yml: config.md + - Supported Protocols: protocols.md + +markdown_extensions: + - md_in_html + - toc: + permalink: true + - pymdownx.highlight + - pymdownx.inlinehilite + - pymdownx.superfences + - pymdownx.magiclink + - pymdownx.blocks.admonition: + types: + - note + - abstract + - info + - tip + - success + - question + - warning + - failure + - danger + - bug + - example + - quote + - pymdownx.blocks.details: + - pymdownx.blocks.tab: + alternate_style: true \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..ceac73c --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +mkdocs-material==9.5.45 \ No newline at end of file diff --git a/wiki/Config.md b/wiki/Config.md deleted file mode 100644 index eb56592..0000000 --- a/wiki/Config.md +++ /dev/null @@ -1,281 +0,0 @@ -[v3.11.0]: https://github.com/Andre601/OneVersionRemake/releases/tag/v3.11.0 - -[minimessage]: https://docs.adventure.kyori.net/minimessage.html -[adventure]: https://github.com/KyoriPowered/adventure - -[colors]: https://docs.adventure.kyori.net/minimessage.html#color -[colorsVerbose]: https://docs.adventure.kyori.net/minimessage.html#color-verbose -[formatting]: https://docs.adventure.kyori.net/minimessage.html#decoration -[reset]: https://docs.adventure.kyori.net/minimessage.html#reset - -[gradient]: https://docs.adventure.kyori.net/minimessage.html#gradient -[keybind]: https://docs.adventure.kyori.net/minimessage.html#keybind -[rainbow]: https://docs.adventure.kyori.net/minimessage.html#rainbow -[translatable]: https://docs.adventure.kyori.net/minimessage.html#translatable - -# 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](#settings) - - [UpdateVersions](#updateversions) - - [VersionsUrl](#versionsurl) -- [Protocol](#protocol) - - [Versions](#versions) - - [LogDenial](#logdenial) - - [MajorOnly](#majoronly) - - [Blacklist](#blacklist) -- [Messages](#messages) - - [Formatting](#formatting) - - [Basic Formatting](#basic-formatting) - - [Advanced Formatting](#advanced-formatting) - - [Not supported Options](#not-supported-options) - - [PlayerCount](#playercount) - - [Kick](#kick) - - [Hover](#hover) - - [Motd](#motd) - -## Settings -Main Settings of the plugin that do not fit any of the other sections. - -### UpdateVersions -> **Type**: `Boolean` -> **Default**: -> ```yaml -> UpdateVersions: true -> ``` - -This options sets whether OneVersionRemake should download the latest versions.json or not when enabling. - -### VersionsUrl -> **Type**: `String` -> **Default**: -> ```yaml -> 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][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**: -> ```yaml -> 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**: -> ```yaml -> 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](#versions) be denied and the following message printed into the console: -``` -[OneVersionRemake] Denied login for Player with MC version (Protocol version ) -``` - -### MajorOnly -> **Type**: `Boolean` -> **Default**: -> ```yaml -> MajorOnly: false -> ``` - -When this option is set to true, will the `{version}` placeholder only display the Major MC versions of the [defined Protocol versions](#versions). - -*Example*: -- Setup: - ```yaml - 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**: -> ```yaml -> Blacklist: false -> ``` - -When this option is set to true, will OneVersionRemake treat the [Protocol List](#versions) 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][minimessage] from [Kyori Adventure][adventure] to provide basic but also advanced color and text formatting options. -Depending on the config option are either only [basic](#basic-formatting) or [advanced](#advanced-formatting) options supported. - -- #### Basic Formatting - - ##### Colors - - | Option 1 | Option 2 | - |-------------------------------------------------|-------------------------------------------------------------| - | [``][colors] | [``][colors] | - | [``][colors] | [``][colors] | - | [``][colors] | [``][colors] | - | [``][colors] | [``][colors] | - | [``][colors] | [``][colors] | - | [``][colors]/[``][colors] | [``][colors]/[``][colors] | - | [``][colors] | [``][colors] | - | [``][colors] | [``][colors] | - | [``][colors] | [``][colors] | - | [``][colors] | [``][colors] | - | [``][colors] | [``][colors] | - | [``][colors] | [``][colors] | - | [``][colors] | [``][colors] | - | [``][colors] | [``][colors] | - | [``][colors] | [``][colors] | - | [``][colors] | [``][colors] | - - ##### Formatting - - | Name | Alias | - |---------------------------------|-----------------------| - | [``][formatting] | [``][formatting] | - | [``][formatting] | [``][formatting] | - | | [``][formatting] | - | [``][formatting] | [``][formatting] | - | [``][reset] | [``][reset] | - | [``][formatting] | [``][formatting] | - | [``][formatting] | | - -- #### Advanced Formatting - Includes [Basic Formatting](#basic-formatting) but also some more advanced options: - - | Option | Format | - |----------------|------------------------------------------------| - | RGB Colors | [`<#rrggbb>`][colors] | - | | [``][colorsVerbose] | - | Gradients* | [``][gradient] | - | Keybind | [``][keybind] | - | Rainbow | [``][rainbow] | - | Translatable** | [``][translatable] | - | | [``][translatable] | - - *Also supports [Color Names](#colors). - **`_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 | - | -------------------------- | -------------------------------------------------------------------- | - | `` | Will render but won't perform anything on click. | - | `` | Requires an active resource pack for the client to display the font. | - | `` | Will render but won't show anything on hover. | - | `` | Will render but not perform on click. | - ----- -### PlayerCount -> **Type**: `String` -> **Default**: -> ```yaml -> PlayerCount: 'Minecraft {version}' -> ``` -> -> **Supported Formatting**: [Basic](#basic-formatting) - -Changes the text that usually displays the player count (`/`). -You can set this to an empty String (`PlayerCount: ''`) to not alter the text or to just a color/formatting code (`PlayerCount: ''`) to hide it completely! - -### Kick -> **Type**: `List (String)` -> **Default**: -> ```yaml -> Kick: -> - 'You are using an unsupported version of Minecraft ({userVersion})!' -> - 'This server supports the following Versions:' -> - '{version}' -> - '' -> - 'Please change your Version and try again.' -> ``` -> -> **Supported Formatting**: [Advanced](#advanced-formatting) - -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: -``` -This Server is running MC {version}! Please change your client version. -``` - -### Hover -> **Type**: `List (String)` -> **Default**: -> ```yaml -> Hover: -> - 'You are using an unsupported version of Minecraft ({userVersion})!' -> - 'Please change your version to {version}.' -> ``` -> -> **Supported Formatting**: [Basic](#basic-formatting) - -This is the text displayed when the player hovers with his cursor over the [Player Count](#playercount). - -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**: -> ```yaml -> Motd: -> - 'Unsupported Minecraft Version {userVersion}' -> - 'Please use {version}.' -> ``` -> -> **Supported Formatting**: [Advanced](#advanced-formatting) - -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. diff --git a/wiki/Home.md b/wiki/Home.md deleted file mode 100644 index 85c68ba..0000000 --- a/wiki/Home.md +++ /dev/null @@ -1,7 +0,0 @@ -Welcome to the OneVersionRemake wiki! - -This wiki contains some smaller information for the plugin. - -## Pages -- [[Config.yml|Config]] -- [[Supported Protocols]] \ No newline at end of file diff --git a/wiki/Supported-Protocols.md b/wiki/Supported-Protocols.md deleted file mode 100644 index 5f69253..0000000 --- a/wiki/Supported-Protocols.md +++ /dev/null @@ -1,59 +0,0 @@ -[protocol_versions.json source]: https://codeberg.org/Andre601/website/src/branch/main/docs/oneversionremake/protocol_versions.json -[versions.json source]: https://codeberg.org/Andre601/website/src/branch/main/docs/oneversionremake/versions.json -[old versions.json source]: https://github.com/Andre601/OneVersionRemake/blob/master/versions.json - -Due to BungeeCord not providing a way to obtain the MC version from a protocol does OneVersionRemake utilize a separate JSON file containing the MC versions and their major versions for the `{version}` and `{userVersion}` placeholders. - -It pulls the JSON from the following sources: - -- v3.11.0 and newer: https://andre601.ch/oneversionremake/protocol_versions.json ([Source][protocol_versions.json source]) -- v3.9.0 to v3.10.0: https://andre601.ch/oneversionremake/versions.json ([Source][versions.json source]) -- v3.8.2 and older: https://raw.githubusercontent.com/Andre601/OneVersionRemake/master/versions.json ([Source][old versions.json source]) - -You can always add your own protocol versions not present within the JSON file if they exist and if you follow the structure of the JSON file. -Unknown/Unsupported versions will be displayed as `?`. - -## Versions - -Here is a complete list of all currently supported protocol versions based on the latest [`protocol_versions.json` file][protocol_versions.json source]. - -| Protocol: | Displayed version: | -|:---------:|:------------------:| -| 765 | 1.20.4 | -| 764 | 1.20.2 | -| 763 | 1.20.1 | -| 762 | 1.19.4 | -| 761 | 1.19.3 | -| 760 | 1.19.2 | -| 759 | 1.19 | -| 758 | 1.18.2 | -| 757 | 1.18.1 | -| 756 | 1.17.1 | -| 755 | 1.17 | -| 754 | 1.16.5 | -| 753 | 1.16.3 | -| 751 | 1.16.2 | -| 736 | 1.16.1 | -| 735 | 1.16 | -| 578 | 1.15.2 | -| 575 | 1.15.1 | -| 573 | 1.15 | -| 498 | 1.14.4 | -| 490 | 1.14.3 | -| 485 | 1.14.2 | -| 480 | 1.14.1 | -| 477 | 1.14 | -| 404 | 1.13.2 | -| 401 | 1.13.1 | -| 393 | 1.13 | -| 340 | 1.12.2 | -| 338 | 1.12.1 | -| 335 | 1.12 | -| 316 | 1.11.2 | -| 315 | 1.11 | -| 210 | 1.10.2 | -| 110 | 1.9.4 | -| 109 | 1.9.2 | -| 108 | 1.9.1 | -| 107 | 1.9 | -| 47 | 1.8.9 | diff --git a/wiki/_Footer.md b/wiki/_Footer.md deleted file mode 100644 index ec191ec..0000000 --- a/wiki/_Footer.md +++ /dev/null @@ -1,19 +0,0 @@ -[website]: https://andre601.ch - -[BungeeCord]: https://github.com/SpigotMC/BungeeCord/ -[Velocity]: https://velocitypowered.com - -[versionBadge]: https://img.shields.io/github/v/release/Andre601/OneVersionRemake?style=for-the-badge -[version]: https://github.com/Andre601/OneVersionRemake/releases - -[licenseBadge]: https://img.shields.io/github/license/Andre601/OneVersionRemake?style=for-the-badge -[license]: https://github.com/Andre601/OneVersionRemake/blob/master/LICENSE - -[issuesBadge]: https://img.shields.io/github/issues-raw/Andre601/OneVersionRemake?style=for-the-badge -[issues]: https://github.com/Andre601/OneVersionRemake/issues - -> © 2020 - 2021 [Andre601][website] -> -> Only allow specific Minecraft versions to join your [BungeeCord] or [Velocity] Network. -> -> [![versionBadge]][version] [![licenseBadge]][license] [![issuesBadge]][issues] \ No newline at end of file diff --git a/wiki/_Sidebar.md b/wiki/_Sidebar.md deleted file mode 100644 index c127787..0000000 --- a/wiki/_Sidebar.md +++ /dev/null @@ -1,5 +0,0 @@ -OneVersionRemake - -## Pages -- [[Config.yml|Config]] -- [[Supported Protocols]] \ No newline at end of file