Skip to content

Commit

Permalink
update document
Browse files Browse the repository at this point in the history
  • Loading branch information
HimaJyun committed Feb 15, 2019
1 parent 804a71e commit dc7dbbe
Show file tree
Hide file tree
Showing 5 changed files with 225 additions and 51 deletions.
86 changes: 67 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,81 @@
Economy base plugin for Bukkit/Spigot
[![Build Status](https://travis-ci.org/HimaJyun/Jecon.svg?branch=master)](https://travis-ci.org/HimaJyun/Jecon)

## Characteristic
## Features
* UUID Ready
* 1.12 Ready
* 1.13 Ready
* Vault Ready
* MySQL(+SQLite) Ready
* Command tab complete
* Easy to use
* API available

## Installation
1. [Download this plugin.](https://github.com/HimaJyun/Jecon/releases/latest "Get Jecon")
2. drop in plugins directory.
3. Server start.
4. config edit.
5. reload

## Settings
Please refer to the comments in the configuration file.
5. reload.

## Command/Permission
|Command |Permission |Description |Default|
|:-----------------------------------------|:---------------|:----------------------------------------|:------|
|/money |jecon.show |Show your balance. |ALL |
|/money [player] |jecon.show.other|Show [player] balance. |OP |
|/money pay <player> <amount> |jecon.pay |Send <amount> to <player>. |ALL |
|/money top [page] |jecon.top |Show the top list. |OP |
|/money give <player> <amount> |jecon.give |Give <amount> to <player>. |OP |
|/money take <player> <amount> |jecon.take |Take <amount> on <player>. |OP |
|/money set <player> <amount> |jecon.set |Set the <amount> of <player>.|OP |
|/money create <player> [amount] |jecon.create |Create <player> account. |OP |
|/money remove <player> |jecon.remove |Remove <player> account. |OP |
|/money reload |jecon.reload |Reload the config. |OP |
|/money help |N/A |Show command help. |ALL |
|Command|Permission|Description|Default|
|:------|:---------|:----------|:------|
|/money|jecon.show|Show your balance.|ALL|
|/money [player]|jecon.show.other|Show [player] balance.|OP|
|/money pay <player> <amount>|jecon.pay|Send <amount> to <player>.|ALL|
|/money set <player> <balance>|jecon.set|Set the balance of <player> to <balance>.|OP|
|/money give <player> <amount>|jecon.give|Give <amount> to <player>.|OP|
|/money take <player> <amount>|jecon.take|Take <amount> on <player>.|OP|
|/money create <player> [balance]|jecon.create|Create <player> account.|OP|
|/money remove <player>|jecon.remove|Remove <player> account.|OP|
|/money top [page]|jecon.top|Show billionaires ranking.|OP|
|/money reload|jecon.reload|Reload the config.|OP|
|/money version|jecon.version|Show version and check new version.|OP|
|/money help|N/A|Show helps.|ALL|

# API
## Maven
```xml
<repositories>
<repository>
<id>himajyun-repo</id>
<url>https://himajyun.github.io/mvn-repo/</url>
</repository>
</repositories>

<dependencies>
<dependency>
<groupId>jp.jyn</groupId>
<artifactId>Jecon</artifactId>
<version>2.0.0</version>
<scope>provided</scope>
</dependency>
</dependencies>
```

## Usage
```java
public class Main extends JavaPlugin {
private Jecon jecon;

@Override
public void onEnable() {
// get plugin
Plugin plugin = Bukkit.getPluginManager().getPlugin("Jecon");
if(plugin == null || !plugin.isEnabled()) {
// not available
getLogger().warning("Jecon is not available.");
}

this.jecon = (Jecon) plugin;
}

public void usage(UUID uuid) {
// get
jecon.getRepository().getDecimal(uuid);

// set
jecon.getRepository().set(uuid, BigDecimal.ZERO);
}
}
```
16 changes: 8 additions & 8 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
</license>
</licenses>
<distributionManagement>
<repository>
<id>internal.repos</id>
<name>internal repo</name>
<url>file://${project.basedir}/mvn-repo</url>
</repository>
</distributionManagement>

<repositories>
<repository>
Expand Down Expand Up @@ -89,13 +96,6 @@
<profile>
<!-- Library version(-P lib) -->
<id>lib</id>
<distributionManagement>
<repository>
<id>internal.repos</id>
<name>internal repo</name>
<url>file://${project.basedir}/mvn-repo</url>
</repository>
</distributionManagement>
<build>
<defaultGoal>clean javadoc:jar source:jar deploy</defaultGoal>
<resources>
Expand Down Expand Up @@ -132,8 +132,8 @@
<artifactSet>
<includes>
<include>jp.jyn:JBukkitLib</include>
<include>org.slf4j:*</include>
<include>com.zaxxer:HikariCP</include>
<include>org.slf4j:*</include>
</includes>
</artifactSet>
<relocations>
Expand Down
Loading

0 comments on commit dc7dbbe

Please sign in to comment.