diff --git a/README.md b/README.md index a7fc307..c3d3058 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,28 @@ # BlackWidow -BlackWidow is a security solution for Minecraft which aims to offer out-of-the-box defense against vulnerabilities which are commonly exploited on online servers. +BlackWidow is a security solution for Minecraft which aims to +offer out-of-the-box defense against vulnerabilities which +are commonly exploited on online servers. + +## Quick Links + +- **Get Support / Contact Us** + + Please join the [ArcanePlugins Discord](https://discord.gg/arcaneplugins-752310043214479462) and use the `#other-lokka30-plugins` channel. + + Alternatively, [please message lokka30](https://www.spigotmc.org/conversations/add?to=lokka30) on SpigotMC. + +- **Documentation** + + View the [BlackWidow Wiki](https://github.com/ArcanePlugins/BlackWidow/wiki). + +- **Source Code** + + View the [BlackWidow Repository](https://github.com/ArcanePlugins/BlackWidow). + +- **Project Tracker / Roadmap** + + View the [BlackWidow Project](https://github.com/orgs/ArcanePlugins/projects/5). ## Features @@ -22,6 +44,39 @@ BlackWidow is a security solution for Minecraft which aims to offer out-of-the-b BlackWidow is built to be robust and lightweight, and doesn't mash half-baked features together to seem appealing (..only to break next update). +- **Plenty more to come!** + + There are a [variety of other features](https://github.com/orgs/ArcanePlugins/projects/5) planned, some major, such as command spying. It has the goal of being a pretty comprehensive security suite. + + However, we currently have no plans for BlackWidow to become an 'anticheat' plugin in the usual sense, which seems to be fulfilled by existing solutions well enough. + +Feel free to see a variety of screenshots below: + + + + + + + + +
+ +#### Blocking working for command execution and suggestions. + +BW_CmdBlocking_Filtration + +#### Translate all of the plugin's chat messages with MiniMessage color support. + +BW_Config_Translations + + + +#### Very powerful command blocker with a fantastic out-of-the-box experience. + +BW_Config_CommandBlocking + +
+ ## Get Started ### Compatibility @@ -44,10 +99,43 @@ Please be advised: > Please note that we are not interested in backporting BlackWidow to older versions of Minecraft/Java/etc. Please update your software, or feel free to fork BlackWidow and backport it. -> We highly recommend **against** using any server software like Magma, Mohist, and Arclight which are basically try to make Forge mods work with Bukkit plugins. Bukkit was *never* designed to work with Forge/Fabric/etc mods. Trying to mix the two often causes lots of unusual issues which burden server owners and plugin maintainers. Thus, we don't provide any support whatsoever for software of this kind. +> **We do NOT recommend** using any server software like Magma, Mohist, and Arclight which *try* to make Forge mods work with Bukkit plugins. Bukkit was *never* designed to work with Forge/Fabric/etc mods. Trying to mix the two often causes lots of unusual issues which burden server owners and plugin maintainers. + +## Projects Used + +Thank you to the following projects for making BlackWidow possible: + +- [**CommandAPI**](https://github.com/JorelAli/CommandAPI) + + Used to conveniently create and manage Brigadier commands. + +- [**Configurate**](https://github.com/SpongePowered/Configurate/) + + Used to seamlessly handle YAML configuration files. + +- [**MiniMessage (adventure)**](https://github.com/KyoriPowered/adventure) + + Used to format chat messages with lovely chat component features. + +- [**PaperMC**](https://papermc.io) + + API used on Paper servers for more advanced features. + +Thanks to all the other projects used, such as SpigotMC, IntelliJ, etc. ## License Notice -Copyright (c) 2024 lokka30 () +Copyright (C) 2024 lokka30 ([email](mailto:lachy@lachy.space)) + +> This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +> +> This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. -Please see [LICENSE](LICENSE.md). +You should have [received a copy](LICENSE.md) of the GNU General Public License +along with this program. If not, see . diff --git a/blackwidowlib/pom.xml b/blackwidowlib/pom.xml index b2d82d6..6c5eebf 100644 --- a/blackwidowlib/pom.xml +++ b/blackwidowlib/pom.xml @@ -24,11 +24,11 @@ io.github.arcaneplugins.blackwidow blackwidow - 1.0.0-SNAPSHOT-6 + 1.0.0 blackwidowlib - 1.0.0-SNAPSHOT-6 + 1.0.0 diff --git a/blackwidowpluginbukkit/pom.xml b/blackwidowpluginbukkit/pom.xml index 419062f..1733e65 100644 --- a/blackwidowpluginbukkit/pom.xml +++ b/blackwidowpluginbukkit/pom.xml @@ -24,11 +24,11 @@ io.github.arcaneplugins.blackwidow blackwidow - 1.0.0-SNAPSHOT-6 + 1.0.0 blackwidowpluginbukkit - 1.0.0-SNAPSHOT-6 + 1.0.0 21 @@ -47,7 +47,7 @@ io.github.arcaneplugins.blackwidow blackwidowlib - 1.0.0-SNAPSHOT-6 + 1.0.0 compile diff --git a/docs/img/BW_CmdBlocking_Filtration.png b/docs/img/BW_CmdBlocking_Filtration.png new file mode 100644 index 0000000..7424db0 Binary files /dev/null and b/docs/img/BW_CmdBlocking_Filtration.png differ diff --git a/docs/img/BW_Config_CommandBlocking.png b/docs/img/BW_Config_CommandBlocking.png new file mode 100644 index 0000000..d72c9a0 Binary files /dev/null and b/docs/img/BW_Config_CommandBlocking.png differ diff --git a/docs/img/BW_Config_Translations.png b/docs/img/BW_Config_Translations.png new file mode 100644 index 0000000..a593563 Binary files /dev/null and b/docs/img/BW_Config_Translations.png differ diff --git a/pom.xml b/pom.xml index 61a81c0..de5987b 100644 --- a/pom.xml +++ b/pom.xml @@ -24,7 +24,7 @@ io.github.arcaneplugins.blackwidow blackwidow - 1.0.0-SNAPSHOT-6 + 1.0.0 pom blackwidowlib