From 8f858e95663baadb7d4a4f740993d30a657d3f7f Mon Sep 17 00:00:00 2001 From: Daniel McCoy Stephenson Date: Wed, 4 Nov 2026 23:59:13 -0700 Subject: [PATCH] Correct README and user guide claims found in a doc sweep The docs said every stable release is booted on each listed version, but 26.3 joined the list after 1.0.0. Also drop the hero image caption's grey lines, which the image does not have, and state the JDK a build needs and everywhere a new supported version must be listed. Co-Authored-By: Claude Opus 5.5 --- CHANGELOG.md | 3 +++ README.md | 6 ++++-- USER_GUIDE.md | 2 +- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b1b514c..955d59d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ### Fixed - `COMMANDS.md` now lists the exact messages `/fly` shows, including the permission-denied and console alerts, which the 1.0.0 entry below said it already did. - `USER_GUIDE.md` and `COMMANDS.md` now say that the console alert is shown to any non-player sender, such as a command block, not only the server console. +- The README and user guide now say that 1.0.0 was not booted on Minecraft 26.3, which was added after that release. +- The README's hero image caption no longer mentions grey lines the image does not have. +- The README now says which JDK a build needs, and that a new supported version also goes in the README and user guide lists. ## [1.0.0] - 2026-10-02 diff --git a/README.md b/README.md index a551ebd..33b04d0 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,14 @@ ![/fly toggling flight on and off](docs/images/fly.png) -*Real in-game output from FlyCommand 1.0.0 on a local throwaway Paper 1.21.11 test server: the commands were typed by a scripted bot client, and the chat it received is drawn as Minecraft-style chat (typed commands appear in the input bars; grey lines say what happened between commands).* +*Real in-game output from FlyCommand 1.0.0 on a local throwaway Paper 1.21.11 test server: the commands were typed by a scripted bot client, and the chat it received is drawn as Minecraft-style chat (typed commands appear in the input bars).* ## Description FlyCommand is a Spigot plugin that lets permitted players toggle flight mode on and off with a single command. It adds one command, `/fly`, and nothing else — there is no configuration file and no persistent data. ## Supported Minecraft Versions -This plugin is supported on the Minecraft versions listed in [`minecraft-versions.json`](minecraft-versions.json): currently **1.19.4**, **1.21.11**, **26.2** and **26.3** (Spigot and its forks). Every stable release is booted on a real server of each of these versions before it is published, and the [Build](.github/workflows/build.yml) workflow checks that the plugin only uses Bukkit API that exists on all of them. Other versions from 1.19.4 onwards are expected to work but are not tested. To support another version, add it to the file: both checks pick it up. +This plugin is supported on the Minecraft versions listed in [`minecraft-versions.json`](minecraft-versions.json): currently **1.19.4**, **1.21.11**, **26.2** and **26.3** (Spigot and its forks). Every stable release is booted on a real server of each of these versions before it is published, and the [Build](.github/workflows/build.yml) workflow checks that the plugin only uses Bukkit API that exists on all of them. 26.3 was added after the 1.0.0 release, so 1.0.0 was not booted on it; the next stable release will be. Other versions from 1.19.4 onwards are expected to work but are not tested. To support another version, add it to the file, which both checks read, and to the lists here and in the [User Guide](USER_GUIDE.md#installation). ## Installation @@ -64,6 +64,8 @@ The plugin is a single class, built with Maven. ### Building +Building needs Maven and a JDK; the workflows use JDK 17. JDK 8 is too old even though the jar targets Java 8, because `maven.compiler.release` needs JDK 9 or later. + ```bash mvn clean package ``` diff --git a/USER_GUIDE.md b/USER_GUIDE.md index 7a62b1d..fa3a504 100644 --- a/USER_GUIDE.md +++ b/USER_GUIDE.md @@ -10,7 +10,7 @@ FlyCommand is a Spigot plugin that lets permitted players toggle flight mode on 2. Place the JAR in your server's `plugins/` folder. 3. Restart the server. -FlyCommand is supported on the Minecraft versions listed in [`minecraft-versions.json`](minecraft-versions.json): currently **1.19.4**, **1.21.11**, **26.2** and **26.3** (Spigot and its forks). +FlyCommand is supported on the Minecraft versions listed in [`minecraft-versions.json`](minecraft-versions.json): currently **1.19.4**, **1.21.11**, **26.2** and **26.3** (Spigot and its forks). 26.3 was added after the 1.0.0 release, so 1.0.0 was not booted on it; the next stable release will be. ## Usage