LocketUtils
Explore the docs »

Report a Bug · Request a Feature . Ask a Question

Table of Contents

• About
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Support
• Contributing
• Authors & contributors
• Security
• License

---

About

LocketUtils is a free discord bot made to solve the issues of keeping unauthorized users out of private discord servers.

Built With

Getting Started

Prerequisites

• Java 21
• Gradle

Installation

1. Open the project in a command shell
2. Run ./gradlew bootjar to build an executable jar file

Usage

1. Make a copy of the locketutils.properties file
2. Move the properties file and the built jar file to a directory your want to use for the bot
3. Configure the bot
4. Run the jar file (ideally from a command shell)

Roadmap

• H2 and SQLite database support
• Prefix command support
• Multiple guild support per instance

See the open issues for a list of proposed features (and known issues).

• Top Feature Requests (Add your votes using the 👍 reaction)
• Top Bugs (Add your votes using the 👍 reaction)
• Newest Bugs

Support

Reach out to the maintainer at one of the following places:

• GitHub issues
• My discord: @hyscript7

Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page for a list of open issues. Please read our contribution guidelines, and thank you for being involved!

Authors & contributors

The original setup of this repository is by HyScript7.

For a full list of all authors and contributors, see the contributors page.

Security

LocketUtils attempts to follow good practices of security, but 100% security cannot be assured. LocketUtils is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.