Skip to content

Commit 1ef3beb

Browse files
mallusrgreatv2mallusrgreatv2
authored
readme changes (#121)
1 parent 709acac commit 1ef3beb

File tree

3 files changed

+26
-33
lines changed

3 files changed

+26
-33
lines changed

‎README.md‎

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,16 @@
1111

1212
## 💿 Installation
1313

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

17-
> [!NOTE]
18-
> A Github account may be required to download.
19-
>
20-
_OR_
21-
- Download from [Modrinth](https://modrinth.com/plugin/neptunepractice)
16+
> You can download from:
17+
>
18+
> - [**Nightly**](https://nightly.link/Solara-Development/Neptune/workflows/maven/master/Plugin.zip) (**latest**; more features, more bugs) <ins>**recommended**</ins>
19+
> - [**Modrinth**](https://modrinth.com/plugin/neptunepractice#download) (**stable**; less features, less bugs).
2220
23-
24-
- Once downloaded, place the `.jar` file inside the `/plugins` directory on your server.
25-
- Restart your server
26-
- Then do `/neptune`
21+
2. Once downloaded, place the `.jar` file inside the **`/plugins`** directory on your server.
22+
3. **Restart** your server.
23+
4. Run the **`/neptune`** command to set up arenas & kits.
2724

2825
## ✨ Core Features
2926

@@ -45,13 +42,13 @@ _OR_
4542

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

48-
[Permissions, Placeholders, and API](./docs/README.md).
45+
[View the documentation](./docs/README.md).
4946

5047
---
5148

5249
## 💬 Support
5350

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

5653
---
5754

‎docs/README.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,4 @@
99
- [💻API](./api.md)
1010

1111
> [!IMPORTANT]
12-
> Join our [Discord server](https://discord.gg/f6rUtpy6y4) for help, updates, and community support.
13-
14-
*MORE INFO COMMING SOON!*
12+
> Join our [Discord server](https://discord.gg/f6rUtpy6y4) for support.

‎docs/placeholders.md‎

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
<img width="2000" height="1000" alt="image(6)" src="https://github.com/user-attachments/assets/76ecdb11-ead6-4598-9d0c-4327503df5ec" />
22

3-
---
3+
---
44

55
# Placeholders
66

7-
> [!NOTE]
8-
> PLACEHOLDER API is required for placeholders you can download it
9-
> from [SPIGOTMC](https://www.spigotmc.org/resources/placeholderapi.6245/)
7+
> [!NOTE] > [PlaceholderAPI](https://placeholderapi.com) is required for placeholders.
108
119
## Globally Available
1210

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

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

3836
| Plugin | PlaceholderAPI | Description |
39-
|--------|----------------|---------------------------------------------------|
37+
| ------ | -------------- | ------------------------------------------------- |
4038
| \<kit> | %neptune_kit% | The display name of the kit the player is editing |
4139

4240
## Party
4341

4442
| Plugin | PlaceholderAPI | Description |
45-
|--------------|---------------------|--------------------------------------------------------|
43+
| ------------ | ------------------- | ------------------------------------------------------ |
4644
| \<leader> | %neptune_leader% | The name of the leader of the party |
4745
| \<size> | %neptune_size% | The number of members in the party |
4846
| \<party-max> | %neptune_party-max% | The maximum number of players that can be in the party |
4947

5048
## Any Match
5149

5250
| Plugin | PlaceholderAPI | Description |
53-
|------------------------------------------------------|----------------------------------------------------------|------------------------------------------------------------|
51+
| ---------------------------------------------------- | -------------------------------------------------------- | ---------------------------------------------------------- |
5452
| \<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 |
5553
| \<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 |
5654
| \<time> | %neptune_time% | The time the match has been active for |
@@ -61,7 +59,7 @@
6159
## Solo Match
6260

6361
| Plugin | PlaceholderAPI | Description |
64-
|----------------------------------------------------------|--------------------------------------------------------------|----------------------------------------------------------------------|
62+
| -------------------------------------------------------- | ------------------------------------------------------------ | -------------------------------------------------------------------- |
6563
| \<opponent> | %neptune_opponent% | The name of the opponent |
6664
| \<opponent-ping> | %neptune_opponent-ping% | The ping of the opponent in milliseconds |
6765
| \<red-hits> | None | Hits of the red player |
@@ -91,7 +89,7 @@
9189
## Team Match
9290

9391
| Plugin | PlaceholderAPI | Description |
94-
|---------------------------------------------------------------|--------------------------------------------------------------|--------------------------------------------------|
92+
| ------------------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------ |
9593
| \<alive> | %neptune_alive% | The number of players alive on the player's team |
9694
| \<max> | %neptune_max% | The total number of players on the player's team |
9795
| \<alive-opponent> | %neptune_opponent-alive% | The number of players alive on the opposing team |
@@ -113,22 +111,22 @@
113111
## FFA Match
114112

115113
| Plugin | PlaceholderAPI | Description |
116-
|----------|-----------------|------------------------------------------------------------|
114+
| -------- | --------------- | ---------------------------------------------------------- |
117115
| \<alive> | %neptune_alive% | The number of players alive in the match |
118116
| \<max> | %neptune_max% | The total number of players that participated in the match |
119117

120118
|
121119

122120
## Leaderboards
123121

124-
| PlaceholderAPI | Description |
125-
|-------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
126-
| %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. |
127-
| %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. |
122+
| PlaceholderAPI | Description |
123+
| ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
124+
| %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. |
125+
| %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. |
128126

129127
Example usage:
130128

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

134132
##

0 commit comments

Comments
 (0)