README.md

Keklist

Keklist is an easy to use custom-made black/whitelist for your minecraft server. It's way more customizable than the basic vanilla whitelist and offers way more features. The general idea of this plugin is to have one plugin for managing who can join your server without banning them. Keklist is really lightweight and doesn't use many resources but still full-featured. Keklist is the only whitelist plugin you'll ever need!

---

Features

Keklist includes many different features to make your whitelist experience as good as possible. Here's a list of all features:

• IPv4 and IPv6 support
• Floodgate/Bedrock support
• Custom MOTD for blacklisted IPs
• Fully customizable messages
  • Including minimessage support
• Discord webhook notifications
• Plan hook
• MySQL MariaDB support for syncing your whitelist across multiple servers
• Ingame GUI
• IP info command
• User info command (includes offline users)
• Block users by continent and country
• Proxy/VPN/Tor block mode
• Require players to add server to their server list
• 2FA support on any commands and on join
• Velocity plugin
  • Adds limbo support
  • API for plugin developers

Keklist also hooks into the following plugins and provides information and add features:

• Luckperms contexts
• PlaceholderAPI
• Plan player analytics
• Geyser & Floodgate
• BKCommonLib

Informations about implementations of these can be found in the wiki

Installation & Download

You can download the latest release version of Keklist on github releases or on modrinth. All versions including beta releases can be found here. Every build for each commit can be found on the teamcity server.

To install Keklist you just need to drop the jar file into your plugins folder and restart your server. Keklist will automatically create a config file. You can find the config file in the plugins/Keklist folder. Keklist requires Paper 1.20.1+ (build: 94+) or forks e.g. Purpur(build: 2018+). More about the config file and other features can be found here.

Keklist officially supports the following server software: Paper, Pufferfish, Purpur

Wiki

If you have any problems or need documentation about the plugin, you can just contact us or visit our wiki here on github! Every feature and the entire config is documented and explained, but feel free to ask anything! Our wiki can be found here

bStats

Keklist uses bStats to collect anonymous data about the plugin. You can disable this in the config.yml file.

---

API

Keklist offers an API for plugin developers to use. You can find the API documentation here. soon
Our maven/gradle dependency:

Maven

<repository>
  <id>keklist-releases</id>
  <name>Keklist release versions</name>
  <url>https://repo.sageee.xyz/releases</url>
</repository>

<dependency>
  <groupId>de.sage.minecraft</groupId>
  <artifactId>keklist</artifactId>
  <version>version</version>
  <scope>provided</scope>
</dependency>

Gradle

repositories {
    maven ("https://repo.sageee.xyz/releases/")
}

dependencies{
    compileOnly("de.sage.minecraft:keklist:version")
}

Self compile

If you want to compile the plugin yourself, you can easily do that. Just run:

git clone https://github.com/Simpig-city/Keklist.git
cd Keklist
./gradlew build

The compiled jar files will be in the build/libs folder. You need to have java jdk 21 installed.

Contributing

If you want to help us with the development of Keklist, you can do that by creating a pull request. We'll review it and if everything is fine, we'll eventually merge it. If you want to add a new feature, please create an issue first, so we can discuss it. If you want to help us with the translation, you can do that here. If you want to help us with the documentation, you can do that on our discord server.

---

Contact

If you have any questions or problems, you can contact us on our discord server. You can also create an issue on github or email us.