Skip to content
forked from M4nu02/GBooster

Spigot-Plugin to provide Global Boosters for JobsReborn, McMMO and Minecraft with MySQL-Support

License

Notifications You must be signed in to change notification settings

cobrex1/GBooster

 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License Quality


Logo

GBooster

Global Boosters for Spigot and Paper
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

Description

GBooster is a Booster Plugin created to provide Global Boosters for JobsReborn, McMMO and Minecraft!

This plugin is perfect for any server wishing to receive donations from their players without becoming pay to win!

Features

  • Global Minecraft Experience Boosters
  • Global McMMO Experience Boosters
  • Global Jobs Experience and Money Boosters
  • MySQL/MariaDB support
  • A Bar that shows active boosters and hides automatically when there are none active
  • Support for scheduled boosters from JobsReborn
  • Placeholders and the ability to create a menu to activate boosters through DeluxeMenus for example
  • Usage of Placeholders in BossBar

Built With

Getting Started

To get the plugin running on your server follow these simple steps.

Commands and Permissions

  1. Permission: gbooster.give
  • Command: /gbooster give <player> <boosterid> <amount>
  • Description: Give a player a certain amount of boosters
  1. Permission: gbooster.use
  • Command: /gbooster use <boosterid>
  • Description: Use a specified booster
  1. Permission: gbooster.time
  • Command: /gbooster time
  • Description: Shows time of booster that ends next

Configuration

config.yml

---
#---------------------------------------------------------------#
#   __________________                       __                 #
#  /  _____/\______   \ ____   ____  _______/  |_  ___________  #
# /   \  ___ |    |  _//  _ \ /  _ \/  ___/\   __\/ __ \_  __ \ #
# \    \_\  \|    |   (  <_> |  <_> )___ \  |  | \  ___/|  | \/ #
#  \______  /|______  /\____/ \____/____  > |__|  \___  >__|    #
#         \/        \/                  \/            \/        #
#---------------------------------------------------------------#

# This bar will be displayed in order when boosters are active
# To not display anything for specified values set them to: ""
# Set every value to "" to disable the bar.
bar-pattern:
  minecraft: "&a%minecraft%% &fExp"
  mcmmo: "&a%mcmmo%% &fMcMMO"
  jobs-xp: "&a%jobs_xp%% &fJob"
  jobs-money: "&a%jobs_money%% &e$"
  duration: " &7[&f%duration% min&7]"
  separator: " &8&mo&r "

# Choose a storage system (mysql or yaml)
storage-system: yaml

# How often the plugin should save players (time in seconds)
saving-time: 600

mysql:
  host: "localhost"
  port: 3306
  database: gbooster
  username: "gbooster"
  password: ""
  prefix: "server_"
  # prefix: "" # Use for no prefix

boosters:
  jobs_xp_2:
    # Choose from jobs_xp, jobs_money, mcmmo and minecraft
    type: jobs_xp
    # Choose a multiplier (only numbers from 1-8 -> +20% would be 1.2)
    multiplier: 2
    # Choose a duration (seconds)
    duration: 3600
  jobs_money_2:
    type: jobs_money
    multiplier: 2
    duration: 3600
  mcmmo_xp_2:
    type: mcmmo
    multiplier: 2
    duration: 3600
  minecraft_xp_2:
    type: minecraft
    # Don't use floating-point numbers for type minecraft!
    multiplier: 2
    duration: 3600

messages.yml

give-boosters: "&fYou gave &e%amount% &f%booster% to &b%player%"
take-boosters: "&fYou took &e%amount% &f%booster% from &b%player%"
#receive-boosters: "&fYou got &e%amount%x &f%booster%"
receive-boosters: []
#lose-boosters: "&fYou lost &e%amount%x &f%booster%"
lose-boosters: []
active-booster: "&aYou just activated a booster"
active-booster-broadcast: "&b%player%&a just activated a booster"
no-active-booster: "&cThere is no active booster!"
booster-timer: "&fNext booster ends in &b%duration%&f minutes."
no-perms: "&cYou don't have enough permissions!"
player-only: "&cThis command can only be executed by players!"
invalid-player: "&cInvalid player!"
invalid-booster: "&cID doesn't exist!"
invalid-amount: "&cInvalid amount!"
countdown-active: "&cYou can only use the same type of booster once!"
limit: "&cThe global limit has been reached!"
no-booster: "&cNo booster of this type available!"
list-booster: "&f%booster% &e%amount%"

Placeholders

  1. Display amount of boosters from player
  • Structure: %gbooster_ + booster_id¹ + %
  • ¹ Exact ID from config.yml including _, can be found under boosters:
  • Example: %gbooster_minecraft_xp_2%
  1. Display multiplier of booster id in percent
  • Structure: %gbooster_ + booster_id¹ + _multiplier%
  • ¹ Exact ID from config.yml including _, can be found under boosters:
  • Example: %gbooster_minecraft_xp_2_multiplier%
  1. Display duration of booster id in minutes
  • Structure: %gbooster_ + booster_id¹ + _duration%
  • ¹ Exact ID from config.yml including _, can be found under boosters:
  • Example: %gbooster_minecraft_xp_2_duration%
  1. Display time until next booster runs out
  • Structure: %gbooster_time%
  1. Usage Example

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be, learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the GNU General Public License v3.0. See LICENSE for more information.

Contact

Leopold Meinel - [email protected] - eMail

Project Link - GBooster - GitHub

Acknowledgements

About

Spigot-Plugin to provide Global Boosters for JobsReborn, McMMO and Minecraft with MySQL-Support

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 100.0%