Skip to content

Commit

Permalink
Merge pull request #179 from KevinDaGame/Feat/readme-update
Browse files Browse the repository at this point in the history
Readme update
  • Loading branch information
KevinDaGame authored Jun 6, 2023
2 parents 1d3847a + 9dfcd95 commit 892f2dc
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,46 @@

VoxelSniper Reimagined
============
The premier long-distance brush editor for [Bukkit](https://bukkit.org/), [Spigot](https://www.spigotmc.org/), [Paper](https://papermc.io/), and most Bukkit-based server distributions.
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/).

**Please note: Our Forge version is in beta**

Discord
-------
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.19 API.
VoxelSniper is being built against the Spigot 1.19 API, and the latest Forge version.

What version do I pick?

### Spigot/Paper
<details>
<summary>Spigot versions</summary>

| Minecraft version | VoxelSniper version | Java version |
|-------------------|------------------------------------------------------------------------------------|----------------|
| *1.16*\* | [8.3.1](https://github.com/KevinDaGame/VoxelSniper-Reimagined/releases/tag/v8.3.1) | Java 16 |
| *1.17*\* | [8.3.1](https://github.com/KevinDaGame/VoxelSniper-Reimagined/releases/tag/v8.3.1) | Java 16 |
| 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 |

\* Please note that we will not provide support when using Minecraft 1.16 or 1.17
</details>

### Forge

<details>
<summary>Forge versions</summary>

| Minecraft version | Voxelsniper version |
|-------------------|---------------------------------------------------------------------------------|
| 1.16, 1.17, 1.18 | Not available |
| 1.19.4 | [Latest](https://github.com/KevinDaGame/VoxelSniper-Reimagined/releases/latest) |

</details>


Compilation
-----------
Expand Down

0 comments on commit 892f2dc

Please sign in to comment.