Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 84 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,106 @@
<img width="2000" height="1000" alt="image(6)" src="https://github.com/user-attachments/assets/76ecdb11-ead6-4598-9d0c-4327503df5ec" />
<div align="center">

---
<img src="https://github.com/user-attachments/assets/76ecdb11-ead6-4598-9d0c-4327503df5ec" alt="Neptune Practice Core" width="100%"/>

# 🌊 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)

<div align="center">
<a href="https://discord.gg/f6rUtpy6y4" target="_blank"><img alt="Discord" src="https://img.shields.io/badge/Discord-100000?style=for-the-badge&logo=Discord&logoColor=white&labelColor=7289da&color=7289da"/></a>&nbsp;
<a href="https://builtbybit.com/resources/neptune-practice-core.44588/" target="_blank"><img alt="BuiltByBit" src="https://img.shields.io/badge/Builtbybit-100000?style=for-the-badge&logo=builtbybit&logoColor=white&labelColor=7289da&color=7289da"/></a>
</div>

---

## 💿 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) <ins>**recommended**</ins>
> - [**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

<table>
<tr>
<td>

**⚔️ Combat**
- 🥊 Kit system (Boxing, Crystal, Axe, and more)
- 🎛️ GUI-based kit editor
- 🌐 Queue ping range filtering

</td>
<td>

**📊 Interface**
- 📊 Animated scoreboards
- 🏆 Instant leaderboard updates
- 🛠️ In-game management menus

</td>
</tr>
<tr>
<td>

**🎨 Customization**
- 🎆 Custom death messages
- 🧩 Highly configurable
- ⚡ Dynamic arena creation

</td>
<td>

**🔌 Integration**
- 🧩 PlaceholderAPI support
- 📄 Party system
- 💻 Developer API

</td>
</tr>
</table>

---

## 🧪 Usage

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

<table>
<thead>
<tr>
<th>Category</th>
<th>Link</th>
</tr>
</thead>
<tbody>
<tr>
<td>💻 <strong>Click to view</strong></td>
<td><a href="./README.md">View →</a></td>
</tr>
</tbody>
</table>

---

Expand All @@ -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.
52 changes: 46 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,52 @@
<img width="2000" height="1000" alt="image(6)" src="https://github.com/user-attachments/assets/76ecdb11-ead6-4598-9d0c-4327503df5ec" />
<div align="center">

<img src="https://github.com/user-attachments/assets/76ecdb11-ead6-4598-9d0c-4327503df5ec" alt="Neptune Practice Core" width="100%"/>

<br/>

# 🌊 Neptune Practice Core

**A modern and powerful minecraft practice core.**

<br/>

[![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/)

</div>

---

## ✨ DOCUMENTATION
## 📚 Documentation

- [📃Permissions](./permissions.md)
- [🅿Placeholders](./placeholders.md)
- [💻API](./api.md)
<table>
<thead>
<tr>
<th>Category</th>
<th>Description</th>
<th>Link</th>
</tr>
</thead>
<tbody>
<tr>
<td>📃 <strong>Permissions</strong></td>
<td>All permissions</td>
<td><a href="./permissions.md">View →</a></td>
</tr>
<tr>
<td>🅿️ <strong>Placeholders</strong></td>
<td>Available PlaceholderAPI placeholders</td>
<td><a href="./placeholders.md">View →</a></td>
</tr>
<tr>
<td>💻 <strong>API</strong></td>
<td>Developer API reference and examples</td>
<td><a href="./api.md">View →</a></td>
</tr>
</tbody>
</table>

---

> [!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.
87 changes: 62 additions & 25 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,80 @@
<img width="2000" height="1000" alt="image(6)" src="https://github.com/user-attachments/assets/76ecdb11-ead6-4598-9d0c-4327503df5ec" />
<div align="center">

<img src="https://github.com/user-attachments/assets/76ecdb11-ead6-4598-9d0c-4327503df5ec" alt="Neptune Practice Core" width="100%"/>

# 💻 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/)

</div>

---

# API
## 📦 Installation

## Maven
### Maven

- Add jitpack to repositories and Neptune to dependencies:
**1.** Add JitPack to your `pom.xml` repositories:

```xml
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<dependency>
<groupId>com.github.Devlrxxh.Neptune</groupId>
<artifactId>API</artifactId>
<version>{latest-commit-hash}</version> <!-- change this to the latest commit hash -->
<scope>provided</scope>
</dependency>
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
```

- Also make sure you have added Neptune as a dependency in your plugin.yml:
**2.** Add Neptune as a dependency:

```xml
<dependency>
<groupId>com.github.Devlrxxh.Neptune</groupId>
<artifactId>API</artifactId>
<version>{latest-commit-hash}</version> <!-- Replace with the latest commit hash -->
<scope>provided</scope>
</dependency>
```

> [!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.
63 changes: 51 additions & 12 deletions docs/permissions.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,56 @@
<img width="2000" height="1000" alt="image(6)" src="https://github.com/user-attachments/assets/76ecdb11-ead6-4598-9d0c-4327503df5ec" />
<div align="center">

<img src="https://github.com/user-attachments/assets/76ecdb11-ead6-4598-9d0c-4327503df5ec" alt="Neptune Practice Core" width="100%"/>

# 🔐 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/)

</div>

---

# 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.<number>` | Set the max member limit for parties created by the player |

> Replace `<number>` 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.<number>` | 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 |
Loading
Loading