Skip to content

readme changes #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Devlrxxh merged 1 commit into from
Oct 31, 2025
Merged

readme changes #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 10 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,16 @@

## 💿 Installation

- Make sure you are using the latest [Paper](https://papermc.io/downloads/paper) version.
- Download the latest [Github Actions](https://github.com/Solara-Development/Neptune/actions) build.
1. **Download** the plugin.

> [!NOTE]
> A Github account may be required to download.
>
_OR_
- Download from [Modrinth](https://modrinth.com/plugin/neptunepractice)
> 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).


- Once downloaded, place the `.jar` file inside the `/plugins` directory on your server.
- Restart your server
- Then do `/neptune`
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.

## ✨ Core Features

Expand All @@ -45,13 +42,13 @@ _OR_

Use the `/neptune` command to create and manage arenas and kits through intuitive in-game menus.

[Permissions, Placeholders, and API](./docs/README.md).
[View the documentation](./docs/README.md).

---

## 💬 Support

Join our [Discord server](https://discord.gg/f6rUtpy6y4) for help, updates, and community support.
Join our [Discord server](https://discord.gg/f6rUtpy6y4) for help, bug reports, and feature requests.

---

Expand Down
4 changes: 1 addition & 3 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,4 @@
- [💻API](./api.md)

> [!IMPORTANT]
> Join our [Discord server](https://discord.gg/f6rUtpy6y4) for help, updates, and community support.

*MORE INFO COMMING SOON!*
> Join our [Discord server](https://discord.gg/f6rUtpy6y4) for support.
32 changes: 15 additions & 17 deletions docs/placeholders.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
<img width="2000" height="1000" alt="image(6)" src="https://github.com/user-attachments/assets/76ecdb11-ead6-4598-9d0c-4327503df5ec" />

---
---

# Placeholders

> [!NOTE]
> PLACEHOLDER API is required for placeholders you can download it
> from [SPIGOTMC](https://www.spigotmc.org/resources/placeholderapi.6245/)
> [!NOTE] > [PlaceholderAPI](https://placeholderapi.com) is required for placeholders.

## Globally Available

| Plugin | PlaceholderAPI | Description |
|------------------|-----------------------------------------------------------------------------|------------------------------------------------------------------------|
| ---------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| \<online> | None<sup style="color: red">\*</sup> | Use server expansion for PAPI |
| \<queued> | %neptune_queued% | Get the number of players in queue |
| \<in-match> | %neptune_in-match% | Get the number of players in matches |
Expand All @@ -27,7 +25,7 @@
## In Queue

| Plugin | PlaceholderAPI | Description |
|-----------------|----------------------------|-----------------------------------------------------------------------|
| --------------- | -------------------------- | --------------------------------------------------------------------- |
| \<kit> | %neptune_kit% | The display name of the kit the player is playing on |
| \<maxPing> | %neptune_maxPing% | The maximum ping allowed by the player in their settings |
| \<time> | %neptune_time% | The time in minutes and seconds that the player has been queueing for |
Expand All @@ -36,21 +34,21 @@
## Kit Editor

| Plugin | PlaceholderAPI | Description |
|--------|----------------|---------------------------------------------------|
| ------ | -------------- | ------------------------------------------------- |
| \<kit> | %neptune_kit% | The display name of the kit the player is editing |

## Party

| Plugin | PlaceholderAPI | Description |
|--------------|---------------------|--------------------------------------------------------|
| ------------ | ------------------- | ------------------------------------------------------ |
| \<leader> | %neptune_leader% | The name of the leader of the party |
| \<size> | %neptune_size% | The number of members in the party |
| \<party-max> | %neptune_party-max% | The maximum number of players that can be in the party |

## Any Match

| Plugin | PlaceholderAPI | Description |
|------------------------------------------------------|----------------------------------------------------------|------------------------------------------------------------|
| ---------------------------------------------------- | -------------------------------------------------------- | ---------------------------------------------------------- |
| \<red-bed-status><sup style="color: red">\*\*</sup> | %neptune_red-bed-broken%<sup style="color: red">$</sup> | The ping of the player in the red team |
| \<blue-bed-status><sup style="color: red">\*\*</sup> | %neptune_blue-bed-broken%<sup style="color: red">$</sup> | The ping of the player in the blue team |
| \<time> | %neptune_time% | The time the match has been active for |
Expand All @@ -61,7 +59,7 @@
## Solo Match

| Plugin | PlaceholderAPI | Description |
|----------------------------------------------------------|--------------------------------------------------------------|----------------------------------------------------------------------|
| -------------------------------------------------------- | ------------------------------------------------------------ | -------------------------------------------------------------------- |
| \<opponent> | %neptune_opponent% | The name of the opponent |
| \<opponent-ping> | %neptune_opponent-ping% | The ping of the opponent in milliseconds |
| \<red-hits> | None | Hits of the red player |
Expand Down Expand Up @@ -91,7 +89,7 @@
## Team Match

| Plugin | PlaceholderAPI | Description |
|---------------------------------------------------------------|--------------------------------------------------------------|--------------------------------------------------|
| ------------------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------ |
| \<alive> | %neptune_alive% | The number of players alive on the player's team |
| \<max> | %neptune_max% | The total number of players on the player's team |
| \<alive-opponent> | %neptune_opponent-alive% | The number of players alive on the opposing team |
Expand All @@ -113,22 +111,22 @@
## FFA Match

| Plugin | PlaceholderAPI | Description |
|----------|-----------------|------------------------------------------------------------|
| -------- | --------------- | ---------------------------------------------------------- |
| \<alive> | %neptune_alive% | The number of players alive in the match |
| \<max> | %neptune_max% | The total number of players that participated in the match |

|

## Leaderboards

| PlaceholderAPI | Description |
|-------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
| %neptune_\<KILLS\|BEST_WIN_STREAK\|DEATHS\|ELO\>_\<kit name\>_\<1-10\>_name% | Returns the player's name with the most kills/win streak/deaths/elo in the select kit. |
| %neptune_\<KILLS\|BEST_WIN_STREAK\|DEATHS\|ELO\>_\<kit name\>_\<1-10\>_value% | Returns the kills/win streak/deaths/elo from the player on the selected kit. |
| PlaceholderAPI | Description |
| ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| %neptune*\<KILLS\|BEST_WIN_STREAK\|DEATHS\|ELO\>*\<kit name\>\_\<1-10\>\_name% | Returns the player's name with the most kills/win streak/deaths/elo in the select kit. |
| %neptune*\<KILLS\|BEST_WIN_STREAK\|DEATHS\|ELO\>*\<kit name\>\_\<1-10\>\_value% | Returns the kills/win streak/deaths/elo from the player on the selected kit. |

Example usage:

- `%neptune_KILLS_Axe_1_name%` -> Lrxh_ (Return the player's name with the most wins in the kit Axe in slot 1)
- `%neptune_KILLS_Axe_1_name%` -> Lrxh\_ (Return the player's name with the most wins in the kit Axe in slot 1)
- `%neptune_KILLS_Axe_1_value%` -> 100 (Return the wins from the player in slot 1)

##
Expand Down