Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
BenceX100 committed Nov 1, 2024
1 parent f368d1b commit 90dd277
Show file tree
Hide file tree
Showing 26 changed files with 311 additions and 24 deletions.
48 changes: 30 additions & 18 deletions Writerside/hi.tree
Original file line number Diff line number Diff line change
Expand Up @@ -184,30 +184,12 @@
<toc-element topic="AxTrade-Multi-Currency-Plugins.md"/>
<toc-element topic="AxTrade-Custom-Currencies.md"/>
</toc-element>
<toc-element topic="AxSellChest.md">
<toc-element topic="Commands.md"/>
<toc-element topic="Configuration.md"/>
<toc-element topic="Supported-plugins_axsc.md"/>
</toc-element>
<toc-element topic="AxVouchers.md">
<toc-element topic="Commands-axvouchers.md"/>
<toc-element topic="Configuration-axvouchers.md"/>
<toc-element topic="Actions.md"/>
<toc-element topic="Requirements.md"/>
</toc-element>
<toc-element topic="AxAFKZone.md">
<toc-element topic="AxAFKZone-Commands.md"/>
<toc-element topic="AxAFKZone-Configuration.md"/>
<toc-element topic="AxAFKZone-Creating-Zones.md"/>
<toc-element topic="AxAFKZone-Adding-Rewards.md"/>
</toc-element>
<toc-element topic="AxDarkAuctions.md">
<toc-element topic="AxDarkAuctions-How-to-create-a-dark-auction.md"/>
<toc-element topic="AxDarkAuctions-Supported-Plugins.md"/>
<toc-element topic="AxDarkAuctions-Custom-Currencies.md"/>
<toc-element topic="AxDarkAuctions-Commands.md"/>
<toc-element topic="AxDarkAuctions-Configuration.md"/>
</toc-element>
<toc-element topic="AxPlayerWarps.md">
<toc-element topic="AxPlayerWarps-Converters.md"/>
<toc-element topic="AxPlayerWarps-Commands.md"/>
Expand All @@ -218,4 +200,34 @@
<toc-element topic="AxPlayerWarps-Supported-Plugins.md"/>
<toc-element topic="AxPlayerWarps-Custom-Currencies.md"/>
</toc-element>
<toc-element topic="Work-In-Progress.md">
<toc-element topic="AxSellChest.md">
<toc-element topic="Commands.md"/>
<toc-element topic="Configuration.md"/>
<toc-element topic="Supported-plugins_axsc.md"/>
</toc-element>
<toc-element topic="AxVouchers.md">
<toc-element topic="Commands-axvouchers.md"/>
<toc-element topic="Configuration-axvouchers.md"/>
<toc-element topic="Actions.md"/>
<toc-element topic="Requirements.md"/>
</toc-element>
<toc-element topic="AxDarkAuctions.md">
<toc-element topic="AxDarkAuctions-How-to-create-a-dark-auction.md"/>
<toc-element topic="AxDarkAuctions-Supported-Plugins.md"/>
<toc-element topic="AxDarkAuctions-Custom-Currencies.md"/>
<toc-element topic="AxDarkAuctions-Commands.md"/>
<toc-element topic="AxDarkAuctions-Configuration.md"/>
</toc-element>
<toc-element topic="AxParties.md">
<toc-element topic="AxParties-Supported-Plugins.md"/>
<toc-element topic="AxParties-Commands.md"/>
<toc-element topic="AxParties-Permissions.md"/>
<toc-element topic="AxParties-Developer-API.md"/>
</toc-element>
<toc-element topic="AxCoupons.md">
<toc-element topic="AxCoupons-Commands.md"/>
<toc-element topic="AxCoupons-Configuration.md"/>
</toc-element>
</toc-element>
</instance-profile>
Binary file added Writerside/images/image_41.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/image_42.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/image_43.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/image_44.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/image_45.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/image_46.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/image_47.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/image_48.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/image_49.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/image_50.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion Writerside/topics/ALL-Plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@

[COLORS](Colors.md)

[ITEM BUILDER](Item-Builder.md)
[ITEM BUILDER](Item-Builder.md)

[MESSAGE UTILITIES](Message-Utilities.md)
5 changes: 5 additions & 0 deletions Writerside/topics/AxAuctions-Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,11 @@
# if true, even if there is only 1 loaded currency, the selector will show
force-currency-selector: false

# how often should people be able to refresh the gui?
# if you use mysql this is probably a good idea to keep high
# on local databases, (like h2) you can set this to any number really
gui-refresh-cooldown-milliseconds: 250

# list of items that CAN'T be sold in the auction house
# note: the name-contains string shouldn't include any color codes
blacklisted-items:
Expand Down
15 changes: 15 additions & 0 deletions Writerside/topics/AxCoupons-Commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Commands

### Claim command
| Command | Description |
|---------------------|--------------|
| /coupon &lt;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 &lt;player> &lt;coupon> | Reset coupon for player |

You need the `axcoupons.admin` permission to use the admin commands!
56 changes: 56 additions & 0 deletions Writerside/topics/AxCoupons-Configuration.md
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: "&#00EEFFYou have successfully claimed the &#00CCFF%name% &#00EEFFcoupon!"
one-time: "&#00EEFFYou have already claimed the &#00CCFF%name% &#00EEFFcoupon."
ip-limit: "&#00EEFFYou can't claim the &#00CCFF%name% &#00EEFFcoupon, because your ip address has reached the claim limit."
on-cooldown: "&#00EEFFYou can't claim the &#00CCFF%name% &#00EEFFcoupon for: &#00CCFF%time%&#00EEFF!"
inactive: "&#00EEFFYou can't claim the &#00CCFF%name% &#00EEFFcoupon."
permission: "&#00EEFFYou don't have permission to claim the &#00CCFF%name% &#00EEFFcoupon."
]]>
</code-block></step>
</procedure>
24 changes: 24 additions & 0 deletions Writerside/topics/AxCoupons.md
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
2 changes: 1 addition & 1 deletion Writerside/topics/AxDarkAuctions.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AxDarkAuctions
# AxDarkAuctions πŸ› οΈ

> This plugin has not released yet, some things are subject to change!
{style="warning"}
Expand Down
16 changes: 16 additions & 0 deletions Writerside/topics/AxParties-Commands.md
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 &lt;player> | axparties.invite | Invite player |
| /party kick &lt;player> | axparties.kick | Kick player |
| /party accept &lt;party> | axparties.accept | Accept invite |
| /party deny &lt;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 &lt;name> | axparties.rename | Rename party |
| /party chat [message] | axparties.chat | Use or toggle party chat |
| /party transfer &lt;player> | axparties.transfer | Transfer party to another player |
84 changes: 84 additions & 0 deletions Writerside/topics/AxParties-Developer-API.md
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;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)!
8 changes: 8 additions & 0 deletions Writerside/topics/AxParties-Permissions.md
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.&lt;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)!
9 changes: 9 additions & 0 deletions Writerside/topics/AxParties-Supported-Plugins.md
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>
27 changes: 27 additions & 0 deletions Writerside/topics/AxParties.md
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)
3 changes: 1 addition & 2 deletions Writerside/topics/AxPlayerWarps-Permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,4 @@
| axplayerwarps.warps.&lt;number> | Number of warps that the player can create | 1 |
| axplayerwarps.delay-bypass | Remove the few second delay/wait before teleporting | op |

* Commands permissions can be found at [**Commands**](AxPlayerWarps-Commands.md)!

* Commands permissions can be found at [**Commands**](AxPlayerWarps-Commands.md)!
2 changes: 1 addition & 1 deletion Writerside/topics/AxSellChest.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AxSellChest
# AxSellChest πŸ› οΈ

> This plugin has not released yet, some things are subject to change!
{style="warning"}
Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/AxVouchers.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AxVouchers
# AxVouchers πŸ› οΈ

> This plugin has not released yet, some things are subject to change!
{style="warning"}
Expand Down
30 changes: 30 additions & 0 deletions Writerside/topics/Work-In-Progress.md
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) | πŸ”¨ |

0 comments on commit 90dd277

Please sign in to comment.