diff --git a/README.md b/README.md index 38ca7de..1296ac0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,100 @@ -# Lockage -Lockage is a miencraft plugin for 1.21.4 to allow users to lock there chests! +# Lockage [EARLY BETA] + +![Version](https://img.shields.io/badge/version-0.0.1--BETA-red) +![Minecraft](https://img.shields.io/badge/minecraft-1.21.4-green) +![Stage](https://img.shields.io/badge/stage-early%20development-red) +![License](https://img.shields.io/badge/license-MIT-blue) + +Created with ❤️ by [Koopa](https://modrinth.com/user/Koopa) + +[Check out my other projects!](https://modrinth.com/user/Koopa) + +![Lockage](https://lapislabs.dev/images/chestlockage.png) + +## ⚠️ Early Development Warning + +**This plugin is currently in EXTREMELY EARLY DEVELOPMENT (v0.0.1-BETA)** +- Features may be incomplete or unstable +- Expect bugs and issues +- Not recommended for production servers +- Database system still being tested +- Use at your own risk! + +## About + +Lockage is a Minecraft plugin that transforms ordinary tripwire hooks into unique chest keys. Simple, intuitive, and secure! + +## Quick Links + +- 🔨 [Development Builds](https://github.com/KoopaCode/Lockage/actions) +- 💬 [Discord Community](https://discord.gg/KmHGjaHWct) +- 🐛 [Report Issues](https://github.com/KoopaCode/Lockage/issues) + +## Features + +- 🔒 Lock chests using tripwire hooks as physical keys +- 🔑 Each key is unique to its chest +- 💾 Persistent storage with SQLite +- 🛡️ Protection against unauthorized access +- 📦 Double chest support +- 💥 Explosion protection +- 🛠️ Admin commands and permissions + +## How It Works + +1. Get a tripwire hook +2. Right-click an unlocked chest +3. The hook transforms into a unique key +4. Only that key can unlock the chest +5. Keep your keys safe! + +## Installation + +1. Download a development build from [GitHub Actions](https://github.com/KoopaCode/Lockage/actions) +2. Place the JAR in your plugins folder +3. Restart your server +4. Start locking chests! + +## Commands + +- `/lockage` - Shows help and information +- `/lockage reload` - Reloads configuration (Admin) + +## Permissions + +- `lockage.use` - Use basic locking features (default: true) +- `lockage.admin` - Access admin commands (default: op) + +## Configuration + +The plugin is configurable through `config.yml`: + +## Known Issues + +- Early beta version (0.0.1-BETA) +- Database system needs testing +- Double chest handling is basic +- More features coming soon! + +## Support & Community + +Join our [Discord](https://discord.gg/KmHGjaHWct) for: +- Development updates +- Bug reports +- Feature requests +- Community support + +## Contributing + +Found a bug? Have a suggestion? We'd love to hear from you! +- Join our Discord +- Create an issue on GitHub +- Submit a pull request + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +--- + +Created with ❤️ by [Koopa](https://modrinth.com/user/Koopa)