From f9f74102d0b120b60e129be46ff2e7d33d6f0ac6 Mon Sep 17 00:00:00 2001 From: hexlocation Date: Sun, 16 Mar 2025 10:00:44 +0100 Subject: [PATCH] add: readme & gitignore --- .gitignore | 1 + README.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 .gitignore create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2f7896d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +target/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..f43f609 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Silencer + +A mute system with only one job that is muting players. +It is designed to be as lightweight as possible, holding only a single class, and using no traditional database of any kind. Instead, it uses [Persistent Data Containers](https://docs.papermc.io/paper/dev/pdc) to store data. + +## Building + +### Dependencies +1. Maven + +### Build + +``` +mvn package +``` + +The plugin will be in the newly-made target folder. +