mirror of
https://github.com/KoopaCode/Lockage.git
synced 2025-04-04 15:27:32 +00:00
324b7aa198
This commit is a quick update to the readme file to allow users to know this a VERY early stage for a huge plugin!
101 lines
2.7 KiB
Markdown
101 lines
2.7 KiB
Markdown
# Lockage [EARLY BETA]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Created with ❤️ by [Koopa](https://modrinth.com/user/Koopa)
|
|
|
|
[Check out my other projects!](https://modrinth.com/user/Koopa)
|
|
|
|
|
|
|
|
## ⚠️ 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)
|