From eb5f5049ed2672795a214e009353d99b6a225237 Mon Sep 17 00:00:00 2001 From: KevDaDev <65958288+KevinDaGame@users.noreply.github.com> Date: Sat, 4 Nov 2023 17:17:19 +0100 Subject: [PATCH] Update readme to include fabric (#228) --- README.md | 48 ++++++++++++++++++++++++++++++++++-------------- 1 file changed, 34 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 35e26600..7b31e66d 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,20 @@ - VoxelSniper Reimagined ============ -The premier long-distance brush editor for [Bukkit](https://bukkit.org/), [Spigot](https://www.spigotmc.org/), [Paper](https://papermc.io/), -most Bukkit-based server distributions and [Forge](https://files.minecraftforge.net/net/minecraftforge/forge/). +The premier long-distance brush editor +for [Bukkit](https://bukkit.org/), [Spigot](https://www.spigotmc.org/), [Paper](https://papermc.io/), +most Bukkit-based server distributions, [Forge](https://files.minecraftforge.net/net/minecraftforge/forge/) +and [Fabric](https://fabricmc.net/). -**Please note: Our Forge version is in beta** +**Please note: Our Fabric version is in beta** -Discord +Discord ------- -For the latest updates, and quick responses to questions, join our [discord server](https://discord.com/invite/YDjykYsAFF)! +For the latest updates, and quick responses to questions, join +our [discord server](https://discord.com/invite/YDjykYsAFF)! Minecraft Version ------------------ -VoxelSniper is being built against the Spigot 1.20 API, and the latest Forge version. +VoxelSniper is being built against the Spigot 1.20 API, the latest Forge version and the latest fabric version. What version do I pick? @@ -25,18 +27,31 @@ What version do I pick? | 1.18 | [Latest](https://github.com/KevinDaGame/VoxelSniper-Reimagined/releases/latest) | Java 17-latest | | 1.19 | [Latest](https://github.com/KevinDaGame/VoxelSniper-Reimagined/releases/latest) | Java 17-latest | | 1.20 | [Latest](https://github.com/KevinDaGame/VoxelSniper-Reimagined/releases/latest) | Java 17-latest | + \* Please note that we will not provide support when using Minecraft 1.16 or 1.17 ### Forge -| Minecraft version | Voxelsniper version | +| Minecraft version | VoxelSniper version | |-------------------|--------------------------------------------------------------------------------------| | 1.16, 1.17, 1.18 | Not available | -| 1.19.4 | [8.9.0](https://github.com/KevinDaGame/VoxelSniper-Reimagined/releases/tag/v8.9.0) | +| *1.19.4*\* | [8.9.0](https://github.com/KevinDaGame/VoxelSniper-Reimagined/releases/tag/v8.9.0) | | 1.20.0 | [8.12.0](https://github.com/KevinDaGame/VoxelSniper-Reimagined/releases/tag/v8.12.0) | | 1.20.1 | [8.12.3](https://github.com/KevinDaGame/VoxelSniper-Reimagined/releases/tag/v8.12.3) | | 1.20.2 | [Latest](https://github.com/KevinDaGame/VoxelSniper-Reimagined/releases/latest) | +\* Please note that the version for 1.19.4 has known issues which will not be fixed + +### Fabric + +** Fabric is in alpha. There will be bugs!** + +| Minecraft version | VoxelSniper version | +|-------------------|--------------------------------------------------------------------------------------| +| *1.20.2*\* | [8.12.5](https://github.com/KevinDaGame/VoxelSniper-Reimagined/releases/tag/v8.12.5) | + +\* Please note that this is an alpha version. It will have bugs and issues. + Compilation ----------- Pre-compiled JARs are available in [Releases](https://github.com/KevinDaGame/VoxelSniper/releases). @@ -49,13 +64,18 @@ Issue Tracker Notes ------------------- How do I create a ticket the right way? -- Seperate your reports. You think there is something wrong, but also want this new brush? Make life easier for us and create two tickets. We'd appreciate it big time. -- Don't tell us your story of life. We want facts and information. The more information about `the Problem` you give us, the easier it is for us to figure out what's wrong. -- Check the closed tickets first. Maybe someone created a similiar ticket already. If you think it's unresolved, then give us more information on there instead. -- Use the correct teplates. Bug reports and feature requests have their own respective templates. If your issue does not fit within those, then use the other template +- Seperate your reports. You think there is something wrong, but also want this new brush? Make life easier for us and + create two tickets. We'd appreciate it big time. +- Don't tell us your story of life. We want facts and information. The more information about `the Problem` you give us, + the easier it is for us to figure out what's wrong. +- Check the closed tickets first. Maybe someone created a similiar ticket already. If you think it's unresolved, then + give us more information on there instead. +- Use the correct teplates. Bug reports and feature requests have their own respective templates. If your issue does not + fit within those, then use the other template Keep in mind that those are guidelines. -We may still look into stuff that does not follow these guidlines, but it will take more effort on our end and will reduce the likelyhood of us handling it. +We may still look into stuff that does not follow these guidlines, but it will take more effort on our end and will +reduce the likelyhood of us handling it. Pull Requests -------------