-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
26 changed files
with
311 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Commands | ||
|
||
### Claim command | ||
| Command | Description | | ||
|---------------------|--------------| | ||
| /coupon <coupon> | Claim coupon | | ||
You need the `axcoupons.use` permission to use the claim command! (it is given by default) | ||
|
||
### Admin commands | ||
| Command | Description | | ||
|--------------------------------------------|-------------------------| | ||
| /couponadmin reload | Reload plugin | | ||
| /couponadmin reset <player> <coupon> | Reset coupon for player | | ||
|
||
You need the `axcoupons.admin` permission to use the admin commands! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# Configuration | ||
|
||
### Configuration of the default coupon: | ||
<procedure title="coupons/example.yml" collapsible="true"><step> | ||
<code-block lang="yaml" ignore-vars="true" collapsible="false" validate="false"> | ||
<![CDATA[ | ||
# DOCUMENTATION: https://docs.artillex-studios.com/axcoupons.html | ||
# ITEM BUILDER: https://docs.artillex-studios.com/item-builder.html | ||
|
||
# what permission is needed to claim? | ||
# set to "" to disable requirement | ||
permission: "" | ||
|
||
# how often this coupon can be activated? | ||
# set to -1 to make it a one time coupon | ||
# this value is in seconds | ||
cooldown: -1 | ||
|
||
# when should this coupon be available? | ||
# if the time is out of this range, the coupon will not be redeemable | ||
# note: you have to set this to the milliseconds since 1970 of the date | ||
# you can use this website: https://currentmillis.com/ (on the right side input the date and copy the milliseconds number) | ||
# set to -1 to disable | ||
activation: | ||
start: -1 | ||
end: -1 | ||
|
||
# how many accounts from one IP address can claim a coupon | ||
# set to -1 to disable | ||
ip-limit: -1 | ||
|
||
# you can add multiple commands/items | ||
rewards: | ||
commands: | ||
- "say %player% claimed the example coupon!" | ||
items: | ||
- material: IRON_INGOT | ||
amount: 1 | ||
name: "&bIron Ingot" | ||
|
||
# list of sounds: https://www.digminecraft.com/lists/sound_list_pc.php | ||
# format: sound|volume|pitch | ||
sounds: | ||
success: "entity.experience_orb.pickup|1|1" | ||
fail: "block.anvil.land|1|1" | ||
|
||
messages: | ||
claim: "�EEFFYou have successfully claimed the �CCFF%name% �EEFFcoupon!" | ||
one-time: "�EEFFYou have already claimed the �CCFF%name% �EEFFcoupon." | ||
ip-limit: "�EEFFYou can't claim the �CCFF%name% �EEFFcoupon, because your ip address has reached the claim limit." | ||
on-cooldown: "�EEFFYou can't claim the �CCFF%name% �EEFFcoupon for: �CCFF%time%�EEFF!" | ||
inactive: "�EEFFYou can't claim the �CCFF%name% �EEFFcoupon." | ||
permission: "�EEFFYou don't have permission to claim the �CCFF%name% �EEFFcoupon." | ||
]]> | ||
</code-block></step> | ||
</procedure> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# AxCoupons π οΈ | ||
|
||
> This plugin has not released yet, some things are subject to change! | ||
{style="warning"} | ||
|
||
## What is AxCoupons? | ||
- A feature rich redeemable coupon / voucher plugin with multi server support. | ||
|
||
![image_46.png](image_46.png) | ||
|
||
## Most Important Features | ||
- **H2 and MySQL support**: With MySQL you can use the plugin on multiple servers at once | ||
- **Unlimited Coupons**: You can create as many coupons as you want | ||
![image_50.png](image_50.png) | ||
- **Per Coupon Messages and Settings**: You can create custom messages for all the coupons | ||
- **One-Time and Reloading Coupons**: Make coupons that can only be redeemed once or set a cooldown and make it redeemable multiple times after a specific cooldown | ||
![image_47.png](image_47.png) | ||
- **Permission Requirement**: Make it that coupons require a permission to redeem | ||
![image_48.png](image_48.png) | ||
- **IP Limits**: Set an IP limit for coupons to prevent abuse | ||
- **Automatically Timed Coupons**: It is possible to set a start and/or end date for coupons and they will only be redeemable in this timespan | ||
- **Command and Item Rewards**: You can create an unlimited number of command and item rewards | ||
![image_49.png](image_49.png) | ||
- **Customizable**: You can change all messages and sounds |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Commands | ||
|
||
| Command | Permission | Description | | ||
|-----------------------------|---------------------------------------------------------------------|----------------------------------| | ||
| /party reload | axparties.reload | Reload plugin | | ||
| /party create [name] | axparties.create | Create party | | ||
| /party disband | axparties.disband | Disband party | | ||
| /party invite <player> | axparties.invite | Invite player | | ||
| /party kick <player> | axparties.kick | Kick player | | ||
| /party accept <party> | axparties.accept | Accept invite | | ||
| /party deny <party> | axparties.deny | Deny invite | | ||
| /party leave | axparties.leave | Leave party | | ||
| /party list [party] | axparties.list (axparties.list.other for the optional [party] part) | List members of party | | ||
| /party rename <name> | axparties.rename | Rename party | | ||
| /party chat [message] | axparties.chat | Use or toggle party chat | | ||
| /party transfer <player> | axparties.transfer | Transfer party to another player | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# Developer API | ||
|
||
<tabs> | ||
|
||
<tab title="Gradle"> | ||
|
||
Add the following to your **repositories** section: | ||
```groovy | ||
maven { url 'https://repo.artillex-studios.com/releases/' } | ||
``` | ||
|
||
Add the dependency to your **dependencies** section: | ||
|
||
```groovy | ||
compileOnly("com.artillexstudios:AxParties:CHANGE-THIS") | ||
``` | ||
</tab> | ||
|
||
<tab title="Maven"> | ||
|
||
Add the following to your **repositories** section: | ||
```xml | ||
<repository> | ||
<id>Artillex-Studios</id> | ||
<url>https://repo.artillex-studios.com/releases/</url> | ||
</repository> | ||
``` | ||
|
||
Add the following to your **dependencies** section: | ||
|
||
```xml | ||
<dependency> | ||
<groupId>com.artillexstudios</groupId> | ||
<artifactId>AxParties</artifactId> | ||
<version>CHANGE-THIS</version> | ||
<scope>provided</scope> | ||
</dependency> | ||
``` | ||
</tab> | ||
</tabs> | ||
<p>Replace <b>CHANGE-THIS</b> to the latest version: <a href="https://repo.artillex-studios.com/#/releases/com/artillexstudios/AxParties"><img src="https://repo.artillex-studios.com/api/badge/latest/releases/com/artillexstudios/AxParties?color=40c14a&amp;name=AxParties" alt=""/></a></p> | ||
|
||
## API Usage | ||
|
||
Don't forget to add AxParties to your plugin's plugin.yml, like this: | ||
```yaml | ||
depend: | ||
- AxParties | ||
``` | ||
or: | ||
```yaml | ||
softdepend: | ||
- AxParties | ||
``` | ||
### Using the API: | ||
The current API is very simple, you can access all the useful methods in the `com.artillexstudios.axparties.api.AxPartiesAPI` class. | ||
|
||
AxPartiesAPI#getParties - | ||
|
||
| Method | Returns | Explanation | | ||
|----------------------|--------------------|-------------------------------------------------------------------------------------| | ||
| getParties | Map<String, Party> | Returns an unmodifiable map of all parties (key = party name, value = party object) | | ||
| getPartyOf(player) | Optional<\Party> | Returns an optional party, it will be empty if the player doesn't have a party | | ||
| getPartyByName(name) | Optional<\Party> | Returns an optional party, it will be empty if the party is not found | | ||
|
||
### Simple example: | ||
|
||
```java | ||
String partyName = "test"; | ||
Optional<Party> partyOptional = AxPartiesAPI.getPartyByName(partyName); | ||
if (partyOptional.isEmpty()) { | ||
System.out.println("Not found"); | ||
} else { | ||
Party party = partyOptional.get(); | ||
System.out.println(party.getName()); | ||
// party.getMembers() - get all members (as OfflinePlayer) | ||
// party.getOnlineMembers() - get online members (as Player) | ||
// party.getOfflineMembers() - get offline members (as OfflinePlayer) | ||
} | ||
``` | ||
|
||
And that's all, if you need anything else, feel free to [contact us](https://dc.artillex-studios.com/) or make a pull request on [github](https://github.com/Artillex-Studios/AxParties)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Permissions | ||
|
||
|-|-| | ||
| Permission | Description | Default | | ||
| axparties.use | Ability to use commands | true | | ||
| axparties.limit.<number> | Override the member slot limit (only if the player is the party owner) | defined in the config.yml > `member-limit` | | ||
|
||
* Commands permissions can be found at [**Commands**](AxParties-Commands.md)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Supported Plugins | ||
|
||
## Plugins that support AxParties: | ||
- AxDungeons (unreleased) | ||
|
||
*Other Ax plugins will support it once the plugin releases* | ||
|
||
> If you add support for AxParties in your own plugin, we can add it to this page, contact us: | ||
<font color="#1f67ff">[dc.artillex-studios.com](https://dc.artillex-studios.com/)</font> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# AxParties π οΈ | ||
|
||
> This plugin has not released yet, some things are subject to change! | ||
{style="warning"} | ||
|
||
|
||
## What is AxPlayerWarps? | ||
- A lightweight party system, perfect for minigame server. | ||
|
||
## Supported platforms: | ||
- Spigot (and forks, like, Paper, Purpur) | ||
- ~~Velocity~~ (not supported yet) | ||
|
||
![image_42.png](image_42.png) | ||
|
||
![image_41.png](image_41.png) | ||
|
||
## Most Important Features | ||
* **Memory only**: The plugin doesn't store any party data after restarts, this makes it very lightweight and perfect for minigames | ||
* **Party Chat** | ||
![image_43.png](image_43.png) | ||
* **Name Rules**: Blacklist unwanted party names | ||
![image_44.png](image_44.png) | ||
* **Member limits**: Set a member limit for parties. You can also give players a higher limits with permissions. | ||
* **Developer API**: Use our simple developer api to hook into AxParties, more info on the wiki | ||
* **Customizable**: All messages are customizable, you can also set some special options | ||
![image_45.png](image_45.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# οΈWork In Progress | ||
|
||
**Some plugins are still in development, but they already have a wiki page.** | ||
|
||
Why is there a wiki if the plugin is not ready yet? It speeds up our work process as different people work on the plugin's code and the page designs. | ||
|
||
### Progress | ||
* Not often updated, might not be accurate | ||
* This page might also include some work in progress plugin rewrites or major updates | ||
|
||
**Status Symbols:** | ||
|
||
β Under testing or waiting for page design\ | ||
π There are some bugs that need fixing\ | ||
π Most features are ready, but it is still missing key things | ||
π¨ In development\ | ||
β Development paused or not started | ||
|
||
*This list might include some plugins that have never even been mentioned publicly, so note that these plugins might never release, or it may take months. There is no ETA.* | ||
|
||
| Plugin | Status | | ||
|------------------------|--------| | ||
| AxSellChest | π¨ | | ||
| AxVouchers | β | | ||
| AxDarkAuctions | π | | ||
| AxParties | β | | ||
| AxCoupons | β | | ||
| AxDungeons | π | | ||
| AxCustomBlocks | π | | ||
| AxMinions V2 (rewrite) | π¨ | |