Skip to content

Commit 5b0da79

Browse files
committed
project: ready for release 1.0.0
1 parent aa8b915 commit 5b0da79

File tree

7 files changed

+98
-10
lines changed

7 files changed

+98
-10
lines changed

README.md

Lines changed: 92 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,28 @@
11
# BlackWidow
22

3-
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.
3+
BlackWidow is a security solution for Minecraft which aims to
4+
offer out-of-the-box defense against vulnerabilities which
5+
are commonly exploited on online servers.
6+
7+
## Quick Links
8+
9+
- **Get Support / Contact Us**
10+
11+
Please join the [ArcanePlugins Discord](https://discord.gg/arcaneplugins-752310043214479462) and use the `#other-lokka30-plugins` channel.
12+
13+
Alternatively, [please message lokka30](https://www.spigotmc.org/conversations/add?to=lokka30) on SpigotMC.
14+
15+
- **Documentation**
16+
17+
View the [BlackWidow Wiki](https://github.com/ArcanePlugins/BlackWidow/wiki).
18+
19+
- **Source Code**
20+
21+
View the [BlackWidow Repository](https://github.com/ArcanePlugins/BlackWidow).
22+
23+
- **Project Tracker / Roadmap**
24+
25+
View the [BlackWidow Project](https://github.com/orgs/ArcanePlugins/projects/5).
426

527
## Features
628

@@ -22,6 +44,39 @@ BlackWidow is a security solution for Minecraft which aims to offer out-of-the-b
2244

2345
BlackWidow is built to be robust and lightweight, and doesn't mash half-baked features together to seem appealing (..only to break next update).
2446

47+
- **Plenty more to come!**
48+
49+
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.
50+
51+
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.
52+
53+
Feel free to see a variety of screenshots below:
54+
55+
<table>
56+
57+
<tr>
58+
<td>
59+
60+
#### Blocking working for command execution and suggestions.
61+
62+
<img width="400" alt="BW_CmdBlocking_Filtration" src="docs/img/BW_CmdBlocking_Filtration.png">
63+
64+
#### Translate all of the plugin's chat messages with MiniMessage color support.
65+
66+
<img width="400" alt="BW_Config_Translations" src="docs/img/BW_Config_Translations.png">
67+
68+
</td>
69+
<td>
70+
71+
#### Very powerful command blocker with a fantastic out-of-the-box experience.
72+
73+
<img width="400" alt="BW_Config_CommandBlocking" src="docs/img/BW_Config_CommandBlocking.png">
74+
75+
</td>
76+
</tr>
77+
78+
</table>
79+
2580
## Get Started
2681

2782
### Compatibility
@@ -44,10 +99,43 @@ Please be advised:
4499
45100
> 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.
46101
47-
> 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.
102+
> **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.
103+
104+
## Projects Used
105+
106+
Thank you to the following projects for making BlackWidow possible:
107+
108+
- [**CommandAPI**](https://github.com/JorelAli/CommandAPI)
109+
110+
Used to conveniently create and manage Brigadier commands.
111+
112+
- [**Configurate**](https://github.com/SpongePowered/Configurate/)
113+
114+
Used to seamlessly handle YAML configuration files.
115+
116+
- [**MiniMessage (adventure)**](https://github.com/KyoriPowered/adventure)
117+
118+
Used to format chat messages with lovely chat component features.
119+
120+
- [**PaperMC**](https://papermc.io)
121+
122+
API used on Paper servers for more advanced features.
123+
124+
Thanks to all the other projects used, such as SpigotMC, IntelliJ, etc.
48125

49126
## License Notice
50127

51-
Copyright (c) 2024 lokka30 (<lachy@lachy.space>)
128+
Copyright (C) 2024 lokka30 ([email](mailto:lachy@lachy.space))
129+
130+
> This program is free software: you can redistribute it and/or modify
131+
it under the terms of the GNU General Public License as published by
132+
the Free Software Foundation, either version 3 of the License, or
133+
(at your option) any later version.
134+
>
135+
> This program is distributed in the hope that it will be useful,
136+
but WITHOUT ANY WARRANTY; without even the implied warranty of
137+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
138+
GNU General Public License for more details.
52139

53-
Please see [LICENSE](LICENSE.md).
140+
You should have [received a copy](LICENSE.md) of the GNU General Public License
141+
along with this program. If not, see <https://www.gnu.org/licenses/>.

blackwidowlib/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@
2424
<parent>
2525
<groupId>io.github.arcaneplugins.blackwidow</groupId>
2626
<artifactId>blackwidow</artifactId>
27-
<version>1.0.0-SNAPSHOT-6</version>
27+
<version>1.0.0</version>
2828
</parent>
2929

3030
<artifactId>blackwidowlib</artifactId>
31-
<version>1.0.0-SNAPSHOT-6</version>
31+
<version>1.0.0</version>
3232
<build>
3333
<plugins>
3434
<plugin>

blackwidowpluginbukkit/pom.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@
2424
<parent>
2525
<groupId>io.github.arcaneplugins.blackwidow</groupId>
2626
<artifactId>blackwidow</artifactId>
27-
<version>1.0.0-SNAPSHOT-6</version>
27+
<version>1.0.0</version>
2828
</parent>
2929

3030
<artifactId>blackwidowpluginbukkit</artifactId>
31-
<version>1.0.0-SNAPSHOT-6</version>
31+
<version>1.0.0</version>
3232

3333
<properties>
3434
<maven.compiler.source>21</maven.compiler.source>
@@ -47,7 +47,7 @@
4747
<dependency>
4848
<groupId>io.github.arcaneplugins.blackwidow</groupId>
4949
<artifactId>blackwidowlib</artifactId>
50-
<version>1.0.0-SNAPSHOT-6</version>
50+
<version>1.0.0</version>
5151
<scope>compile</scope>
5252
</dependency>
5353
<dependency>
38 KB
Loading
207 KB
Loading
82.9 KB
Loading

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
<groupId>io.github.arcaneplugins.blackwidow</groupId>
2626
<artifactId>blackwidow</artifactId>
27-
<version>1.0.0-SNAPSHOT-6</version>
27+
<version>1.0.0</version>
2828
<packaging>pom</packaging>
2929
<modules>
3030
<module>blackwidowlib</module>

0 commit comments

Comments
 (0)