README.en.md · StonesCraft_Official/VipSystemRecode

# VipSystemEx

[![](https://www.jitpack.io/v/com.gitee.Soldier233/VipSystemRecode.svg)](https://www.jitpack.io/#com.gitee.Soldier233/VipSystemRecode)

## Description
VipSystemEx can do you a favor to manage the Vip of your server. The plugin supports permanent, timed, switchable vip group.  
VipSystemEx use cached MySQL or SQLite with indexes as database, supporting enable/disable connection pool(default on), which ensures the compatibility and the efficiency.

## Commands

## Instructions
### Fundamental Usage
#### Preparations
Install the plugin to server,and restart.    
You don't need to configure the default group.The plugin will set the default group automatically according to your permission plugin.      
Create a vip group named as vip for example.  
Note: If you have installed previous version of VipSystem, the data will be imported from the old version.  
#### Give Vip
Assuming that the player to be given vip is Test.You need to give Test a 30-day vip group.    
Use the command```/vipsys give Test vip 30d```  
The player can use ```/vipsys me``` to check himself vip detail.    
To remove vip, use```/vipsys remove Test```.  
#### Placeholder
If you need to use placeholder provided by VipSystemEx, you need to install plugin PlaceholderAPI.    
Use command```/papi ecloud download vipsystem```to load extension.  
Then you can use the placeholders.  
Below are the mappings.

### Advanced Usage
#### Language
The plugin has two languages,Chinese & English, built-in.You can set```lang```to```zh_CN```or```en```to switch languages.    
You can also customize your language，set```lang```to your own language,reload the plugin,and the plugin will generate a new file named as what you set in folder```messages```copying from en.yml. You can edit it as you wish.  
#### UUID Mode
If you enabled online mode  
It is recommended to apply ```uuid: true```
#### Default Group
The plugin will determine the group to return according to the permission plugin.  
If you want to override the default group, you can set```defaultGroup: builder```    
To set the default group to builder or something else.
#### Database
The plugin use HikariCP as database to connect SQLite database as default.If you don't have special needs, you can ignore the section.    
If the plugin goes wrong when enabling, you need to set```usePool``` to ```false```  
If you need to use MySQL,you can set```useMySQL``` to ```true``` and configure the jdbc address below.
#### Global Vip
If you are using GroupManager, you need not to modify the section without special intention.   
If you are using PermissionsEx, in case the vip cannot be applied to all the worlds, you need to set```isGlobal``` to ```false```  
If the problem still occurs, you need to add all you worlds in```worlds```  
```
worlds:
  - world
  - world_nether
  - world_the_end
```
#### Custom Command
You can define the command to be executed when activating/disabling the vip.
```
customCommands:
  vip:
    activate:
      - 'say {0} has activated vip!'
      - 'give {0} minecraft:diamond'
    expire:
      - 'say {0} is no longer a vip'
  svip:
    activate:
      - 'say {0} has activated svip!'
      - 'give {0} minecraft:diamond'
    expire:
      - 'say {0} is no longer a svip'
```
When activating vip, the commands below will be executed, send messages and give a diamond.
```
say {0} has activated vip!
give {0} minecraft:diamond
```
When vip expires, the commands below will be executed, send messages.
```
say {0} is no longer a vip
```
If you need to add more groups, it is the same method.  
If you don't need the function, you can delete it.
## API
You can use```VipSystemAPI.getInstance()``` to get the instance of ```VipSystemAPI```  
Javadoc is on the way.

StonesCraft_Official/VipSystemRecode

简介

发行版

贡献者

近期动态

StonesCraft_Official/VipSystemRecode .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

StonesCraft_Official/VipSystemRecode