Skip to content

Latest commit

 

History

History
201 lines (161 loc) · 6.91 KB

README.md

File metadata and controls

201 lines (161 loc) · 6.91 KB
Raw

Contributors Forks Stargazers Issues MIT License Quality


Logo

GBooster

Global Boosters for Spigot and Paper
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

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

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: DEFAULT
  • Command: /gbooster use <boosterid>
  • Description: Use a specified booster

Configuration

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

# This bar will be displayed when boosters are active
bar-pattern: "&b%minecraft%x &aEXP &7| &b%mcmmo%x &aMcMMO &7| &b%jobs_xp%x &aJob &7| &b%jobs_money%x &e$ &7[&f%duration% m&7]"

# Message that will be displayed if empty-bar is set to true
default-bar-message: "&c&lNo active boosters"

# Set this option to false to not display the default message when no boosters are active
empty-bar: false

# 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: ""

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! All decimals after the . will get rounded
    multiplier: 2
    duration: 3600

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 - @TamrielN - Twitter

Leopold Meinel - [email protected] - email

Project Link: https://github.com/TamrielNetwork/GBooster

Acknowledgements