Skip to content

Commit

Permalink
project: ready for release 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
lokka30 committed Nov 11, 2024
1 parent aa8b915 commit 5b0da79
Show file tree
Hide file tree
Showing 7 changed files with 98 additions and 10 deletions.
96 changes: 92 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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:

<table>

<tr>
<td>

#### Blocking working for command execution and suggestions.

<img width="400" alt="BW_CmdBlocking_Filtration" src="docs/img/BW_CmdBlocking_Filtration.png">

#### Translate all of the plugin's chat messages with MiniMessage color support.

<img width="400" alt="BW_Config_Translations" src="docs/img/BW_Config_Translations.png">

</td>
<td>

#### Very powerful command blocker with a fantastic out-of-the-box experience.

<img width="400" alt="BW_Config_CommandBlocking" src="docs/img/BW_Config_CommandBlocking.png">

</td>
</tr>

</table>

## Get Started

### Compatibility
Expand All @@ -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 (<lachy@lachy.space>)
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 <https://www.gnu.org/licenses/>.
4 changes: 2 additions & 2 deletions blackwidowlib/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@
<parent>
<groupId>io.github.arcaneplugins.blackwidow</groupId>
<artifactId>blackwidow</artifactId>
<version>1.0.0-SNAPSHOT-6</version>
<version>1.0.0</version>
</parent>

<artifactId>blackwidowlib</artifactId>
<version>1.0.0-SNAPSHOT-6</version>
<version>1.0.0</version>
<build>
<plugins>
<plugin>
Expand Down
6 changes: 3 additions & 3 deletions blackwidowpluginbukkit/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@
<parent>
<groupId>io.github.arcaneplugins.blackwidow</groupId>
<artifactId>blackwidow</artifactId>
<version>1.0.0-SNAPSHOT-6</version>
<version>1.0.0</version>
</parent>

<artifactId>blackwidowpluginbukkit</artifactId>
<version>1.0.0-SNAPSHOT-6</version>
<version>1.0.0</version>

<properties>
<maven.compiler.source>21</maven.compiler.source>
Expand All @@ -47,7 +47,7 @@
<dependency>
<groupId>io.github.arcaneplugins.blackwidow</groupId>
<artifactId>blackwidowlib</artifactId>
<version>1.0.0-SNAPSHOT-6</version>
<version>1.0.0</version>
<scope>compile</scope>
</dependency>
<dependency>
Expand Down
Binary file added docs/img/BW_CmdBlocking_Filtration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/BW_Config_CommandBlocking.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/BW_Config_Translations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

<groupId>io.github.arcaneplugins.blackwidow</groupId>
<artifactId>blackwidow</artifactId>
<version>1.0.0-SNAPSHOT-6</version>
<version>1.0.0</version>
<packaging>pom</packaging>
<modules>
<module>blackwidowlib</module>
Expand Down

0 comments on commit 5b0da79

Please sign in to comment.