https://github.com/guilds-plugin/guildsupkeep
A basic addon that allows you to set an upkeep for running a Guild
https://github.com/guilds-plugin/guildsupkeep
Last synced: 10 months ago
JSON representation
A basic addon that allows you to set an upkeep for running a Guild
- Host: GitHub
- URL: https://github.com/guilds-plugin/guildsupkeep
- Owner: guilds-plugin
- Created: 2025-02-23T15:48:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-23T17:58:22.000Z (about 1 year ago)
- Last Synced: 2025-05-16T21:14:28.728Z (12 months ago)
- Language: Java
- Size: 45.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GuildsUpkeep
GuildsUpkeep is a Minecraft plugin designed to work with the Guilds plugin. It provides an upkeep system that periodically pulls money from all guilds as a form of maintenance. If a guild does not have enough money in their bank balance, it will be declared bankrupt and deleted.
## Features
- Configurable upkeep interval (default is 1 day).
- Configurable amount to pull from each guild during upkeep.
- Tracks the last time upkeep was performed.
- Deletes guilds that cannot afford the upkeep and broadcasts a message to the server.
## Configuration
The configuration file (`config.yml`) allows you to set the upkeep interval, amount, and track the last upkeep time.
```yaml
upkeep:
interval: 86400 # in seconds (default 1 day)
amount: 1000 # amount to pull each time
last_upkeep: 0 # timestamp of the last upkeep
```
## Installation
1) Download the GuildsUpkeep plugin jar file.
2) Place the jar file in the `plugins` directory of your Minecraft server.
3) Start the server to generate the default configuration file.
4) Edit the `config.yml` file in the `plugins/GuildsUpkeep` directory to customize the upkeep settings.
5) Restart the server to apply the changes.
## Usage
Once installed and configured, the plugin will automatically perform upkeep at the specified interval. It will pull the configured amount from each guild's bank balance and handle bankrupt guilds accordingly.
## Dependencies
- [Guilds](https://github.com/guilds-plugin/Guilds) plugin version 3.5.7.0 or higher.
- Spigot API version 1.21.4-R0.1-SNAPSHOT or higher.