/SwoftyEconomy

Custom economy plugin based on MongoDB with no external libraries - Fully documented and configurable.

Primary LanguageJavaApache License 2.0Apache-2.0

Swofty Economy

badge badge badge badge

JavaDoc 1.0.0

A fully custom Economy plugin with no external libraries. All message are configurable. Current supported commands are;

To Do

Table of contents

Images

Getting started

This API does not support stand-alone usage, and you will need to add the project jar into your plugins folder. An updated version of the API jar can be found inside of the releases tab on the right of this readme. This projects JavaDoc (documentation for every method) can be found here.

Add SwoftyEconomy to your project

badge

First, you need to setup the dependency inside of your Java project. Replace VERSION with the version of the release.

Maven

<dependency>
    <groupId>net.swofty</groupId>
    <artifactId>economy</artifactId>
    <version>VERSION</version>
</dependency>

Gradle

dependencies {
    implementation 'net.swofty:economy:VERSION'
}

Setting up the configuration file

CONFIG.yml

#
#      Swofty Economy
#       Swofty#0001
#
#      Plugin Config
#

MESSAGES.yml

#
#      Swofty Economy
#       Swofty#0001
#
#     Messages Config
#

#
#  To use hex colors inside of messages, merely add the variable name and its
#  hex color value here. After you have done this you can use the variable
#  inside any of the messages
#
#  So to use this example hex color, you should use the $HEXCOLOREXAMPLE variable
#
hex-colors:
  HEXCOLOREXAMPLE: "#3CEC5D"

messages:

License

SwoftyEconomy is licensed under the permissive MIT license. Please see LICENSE.txt for more information.