diff --git a/README.md b/README.md index c0a21011..7c4ecab8 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,79 @@ -image(6) +
---- +Neptune Practice Core + +# 🌊 Neptune Practice Core + +**A powerful, feature-rich practice core built for competitive Minecraft servers.** + +[![Discord](https://img.shields.io/badge/Discord-Join%20Server-7289da?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/f6rUtpy6y4) +[![BuiltByBit](https://img.shields.io/badge/BuiltByBit-Purchase-7289da?style=for-the-badge&logo=builtbybit&logoColor=white)](https://builtbybit.com/resources/neptune-practice-core.44588/) +[![Modrinth](https://img.shields.io/badge/Modrinth-Stable-00AF5C?style=for-the-badge&logo=modrinth&logoColor=white)](https://modrinth.com/plugin/neptunepractice#download) -
- Discord  - BuiltByBit
--- ## πŸ’Ώ Installation -0. You need a PaperMC server (or forks of PaperMC) with version **1.21.11** or above. +> [!IMPORTANT] +> Requires a **PaperMC** server running **1.21.1**. -1. **Download** the plugin. +**1.** Download the plugin β€” choose a build that suits your needs: -> You can download from: -> -> - [**Nightly**](https://nightly.link/Solara-Development/Neptune/workflows/maven/master/Plugin.zip) (**latest**; more - features, more bugs) **recommended** -> - [**Modrinth**](https://modrinth.com/plugin/neptunepractice#download) (**stable**; less features, less bugs). +| Build | Link | Notes | +|---|---|---| +| πŸŒ™ **Nightly** *(recommended)* | [Download](https://nightly.link/Solara-Development/Neptune/workflows/maven/master/Plugin.zip) | Latest features, may contain bugs | +| 🟒 **Stable** | [Modrinth](https://modrinth.com/plugin/neptunepractice#download) | Fewer features, fewer bugs | -2. Once downloaded, place the `.jar` file inside the **`/plugins`** directory on your server. -3. **Restart** your server. -4. Run the **`/neptune`** command to set up arenas & kits. +**2.** Place the `.jar` file into your server's `/plugins` directory. -## ✨ Core Features +**3.** Restart your server. -- πŸ₯Š Kit System (Boxing, Crystal, Axe, and more) -- πŸŽ›οΈ GUI-Based Kit Editor -- 🌐 Queue Ping Range System -- πŸ“Š Animated Scoreboards -- 🧩 PlaceholderAPI Support -- πŸŽ† Custom Death Messages -- πŸ› οΈ Management Menus -- πŸ† Instant Leaderboards Updates -- 🧩 Highly Customizable -- ⚑ Dynamic Arena Creation -- πŸ“„ Party System +**4.** Run `/neptune` to begin setting up arenas and kits. + +--- + +## ✨ Features + + + + + + + + + + +
+ +**βš”οΈ Combat** +- πŸ₯Š Kit system (Boxing, Crystal, Axe, and more) +- πŸŽ›οΈ GUI-based kit editor +- 🌐 Queue ping range filtering + + + +**πŸ“Š Interface** +- πŸ“Š Animated scoreboards +- πŸ† Instant leaderboard updates +- πŸ› οΈ In-game management menus + +
+ +**🎨 Customization** +- πŸŽ† Custom death messages +- 🧩 Highly configurable +- ⚑ Dynamic arena creation + + + +**πŸ”Œ Integration** +- 🧩 PlaceholderAPI support +- πŸ“„ Party system +- πŸ’» Developer API + +
--- @@ -45,7 +81,26 @@ Use the `/neptune` command to create and manage arenas and kits through intuitive in-game menus. -[View the documentation](./docs/README.md). +πŸ“š **[View Full Documentation](./docs/README.md)** + +--- + +## πŸ“š Documentation + + + + + + + + + + + + + + +
CategoryLink
πŸ’» Click to viewView β†’
--- @@ -57,4 +112,4 @@ Join our [Discord server](https://discord.gg/f6rUtpy6y4) for help, bug reports, ## πŸ‘€ Maintainer -Project by [DevLrxxh](https://github.com/Devlrxxh) +Built and maintained by [DevLrxxh](https://github.com/Devlrxxh) and our wonderful Contributors. diff --git a/docs/README.md b/docs/README.md index 4b589db2..7cab82a1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,12 +1,52 @@ -image(6) +
+ +Neptune Practice Core + +
+ +# 🌊 Neptune Practice Core + +**A modern and powerful minecraft practice core.** + +
+ +[![Discord](https://img.shields.io/badge/Discord-Join%20Server-7289da?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/f6rUtpy6y4) +[![BuiltByBit](https://img.shields.io/badge/BuiltByBit-Purchase-7289da?style=for-the-badge&logo=builtbybit&logoColor=white)](https://builtbybit.com/resources/neptune-practice-core.44588/) + +
--- -## ✨ DOCUMENTATION +## πŸ“š Documentation -- [πŸ“ƒPermissions](./permissions.md) -- [πŸ…ΏPlaceholders](./placeholders.md) -- [πŸ’»API](./api.md) + + + + + + + + + + + + + + + + + + + + + + + + + +
CategoryDescriptionLink
πŸ“ƒ PermissionsAll permissionsView β†’
πŸ…ΏοΈ PlaceholdersAvailable PlaceholderAPI placeholdersView β†’
πŸ’» APIDeveloper API reference and examplesView β†’
+ +--- > [!IMPORTANT] -> Join our [Discord server](https://discord.gg/f6rUtpy6y4) for support. +> Need help? Join our [Discord server](https://discord.gg/f6rUtpy6y4) for support, updates, and community resources. diff --git a/docs/api.md b/docs/api.md index 4ad430b3..5d68ce8c 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,43 +1,80 @@ -image(6) +
+ +Neptune Practice Core + +# πŸ’» API + +**Integrate Neptune into your own plugins with the developer API.** + +[![Discord](https://img.shields.io/badge/Discord-Join%20Server-7289da?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/f6rUtpy6y4) +[![BuiltByBit](https://img.shields.io/badge/BuiltByBit-Purchase-7289da?style=for-the-badge&logo=builtbybit&logoColor=white)](https://builtbybit.com/resources/neptune-practice-core.44588/) + +
--- -# API +## πŸ“¦ Installation -## Maven +### Maven -- Add jitpack to repositories and Neptune to dependencies: +**1.** Add JitPack to your `pom.xml` repositories: ```xml - - - jitpack.io - https://jitpack.io - - - - com.github.Devlrxxh.Neptune - API - {latest-commit-hash} - provided - + + + jitpack.io + https://jitpack.io + + ``` -- Also make sure you have added Neptune as a dependency in your plugin.yml: +**2.** Add Neptune as a dependency: + +```xml + + com.github.Devlrxxh.Neptune + API + {latest-commit-hash} + provided + +``` + +> [!TIP] +> Find the latest commit hash on the [Neptune GitHub repository](https://github.com/Devlrxxh/Neptune). + +--- + +**3.** Declare Neptune as a dependency in your `plugin.yml`: ```yml depend: [Neptune] ``` -## Usage +--- + +## πŸš€ Usage + +Obtain the API instance and access any of the available services: ```java NeptuneAPI neptune = NeptuneAPIProvider.getAPI(); -neptune.getProfileService(); -neptune.getMatchService(); -neptune.getKitService(); -neptune.getScoreboardService(); -neptune.getArenaService(); -neptune.getDivisionService(); -neptune.getCosmeticService(); ``` + +--- + +## πŸ› οΈ Available Services + +| Method | Description | +|---|---| +| `neptune.getProfileService()` | Access and manage player profiles | +| `neptune.getMatchService()` | Interact with active and historical matches | +| `neptune.getKitService()` | Manage kits and kit configurations | +| `neptune.getScoreboardService()` | Control scoreboard rendering | +| `neptune.getArenaService()` | Access and manage arenas | +| `neptune.getDivisionService()` | Retrieve division data and thresholds | +| `neptune.getCosmeticService()` | Manage cosmetics and their assignments | + +--- + +> [!IMPORTANT] +> Need help integrating the API? Join our [Discord server](https://discord.gg/f6rUtpy6y4) for developer support. diff --git a/docs/permissions.md b/docs/permissions.md index b6bafef0..eb1bb9c6 100644 --- a/docs/permissions.md +++ b/docs/permissions.md @@ -1,17 +1,56 @@ -image(6) +
+ +Neptune Practice Core + +# πŸ” Permissions + +**All permission nodes required for Neptune features.** + +[![Discord](https://img.shields.io/badge/Discord-Join%20Server-7289da?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/f6rUtpy6y4) +[![BuiltByBit](https://img.shields.io/badge/BuiltByBit-Purchase-7289da?style=for-the-badge&logo=builtbybit&logoColor=white)](https://builtbybit.com/resources/neptune-practice-core.44588/) + +
--- -# Permissions +> [!TIP] +> Permissions can be granted via any permissions plugin (e.g. LuckPerms, PermissionsEx). + +--- + +## βš™οΈ Administration + +| Permission | Description | +|---|---| +| `neptune.admin` | Access the arena & kit management menu | + +--- + +## 🎨 Cosmetics + +| Permission | Description | +|---|---| +| `neptune.cosmetics.kill-effects.[name]` | Allow use of a specific kill effect | +| `neptune.cosmetics.killmessages.[name]` | Allow use of a specific kill message | + +> Replace `[name]` with the internal name of the cosmetic. + +--- + +## πŸŽ‰ Party + +| Permission | Description | +|---|---| +| `neptune.party.advertise` | Advertise a party publicly | +| `neptune.party.max.` | Set the max member limit for parties created by the player | + +> Replace `` with the desired party size cap (e.g. `neptune.party.max.10`). + +--- -These are the permissions a player needs to do specific things with the plugin. +## πŸ‘οΈ Spectating & Duels -| Permission | Usage | -|-----------------------------------------|-------------------------------------------------------------| -| `neptune.admin` | Access arena & kit management menu | -| `neptune.cosmetics.kill-effects.[name]` | Use a specific kill effect | -| `neptune.cosmetics.killmessages.[name]` | Use a specific kill message | -| `neptune.party.advertise` | Advertise party publicly | -| `neptune.silent-spectate` | Spectate someone silently | -| `neptune.arenaselector` | Access to duel arena selector menu | -| `neptune.party.max.` | Change max member limit for any party created by the player | +| Permission | Description | +|---|---| +| `neptune.silent-spectate` | Spectate a player without notifying them | +| `neptune.arenaselector` | Access the duel arena selector menu | diff --git a/docs/placeholders.md b/docs/placeholders.md index b10ac0e6..d71c1b28 100644 --- a/docs/placeholders.md +++ b/docs/placeholders.md @@ -1,150 +1,180 @@ -image(6) +
+ +Neptune Practice Core + +# πŸ…ΏοΈ Placeholders + +**Reference for all available Neptune placeholders.** + +[![Discord](https://img.shields.io/badge/Discord-Join%20Server-7289da?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/f6rUtpy6y4) +[![BuiltByBit](https://img.shields.io/badge/BuiltByBit-Purchase-7289da?style=for-the-badge&logo=builtbybit&logoColor=white)](https://builtbybit.com/resources/neptune-practice-core.44588/) + +
+ +--- + +> [!NOTE] +> [PlaceholderAPI](https://placeholderapi.com) is required to use `%neptune_..%` placeholders. + +> [!WARNING] +> This page may not always be fully up-to-date. + +--- + +## 🌐 Globally Available + +| Plugin Placeholder | PlaceholderAPI | Description | +|---|---|---| +| `` | β€” `*` | Online player count (use server expansion) | +| `` | `%neptune_queued%` | Number of players currently in queue | +| `` | `%neptune_matches%` | Number of players currently in matches | +| `` | β€” `*` | Name of the player | +| `` | `%neptune_ping%` | Player's ping in milliseconds | +| `` | `%neptune_wins%` | Total wins accumulated | +| `` | `%neptune_losses%` | Total losses accumulated | +| `` | `%neptune_kills%` | Total kills accumulated | +| `` | `%neptune_deaths%` | Total deaths accumulated | +| `` | `%neptune_current_win_streak%` | Player's current win streak | +| `` | `%neptune_best_win_streak%` | Player's all-time best win streak | +| `` | `%neptune_division%` | Player's global division name | +| β€” | `%neptune_kit__%` | Kit-specific stat β€” replace `` with: `name`, `elo`, `division`, `rounds`, `current_win_streak`, `best_win_streak`, `wins`, `losses`, `kills`, `deaths`, `queued`, `in_match` | +| β€” | `%neptune_recent_match__%` | Recent match details β€” replace `` with: `opponent`, `arena`, `kit`, `date`, `time`, `unix_timestamp` *(seconds, not ms)* | +| β€” | `%neptune_state%` | Current state of the player | + +--- + +## ⏳ In Queue + +| Plugin Placeholder | PlaceholderAPI | Description | +|---|---|---| +| `` | `%neptune_kit_name%` | Display name of the kit being queued for | +| `` | `%neptune_kit_division%` | Division for the kit | +| `` | `%neptune_max_ping%` | Max ping allowed per player settings | +| `