diff --git a/README.md b/README.md index fe2a7f09..2b5d701d 100644 --- a/README.md +++ b/README.md @@ -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) **recommended** +> - [**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 @@ -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. --- diff --git a/docs/README.md b/docs/README.md index fcb875d0..4b589db2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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. diff --git a/docs/placeholders.md b/docs/placeholders.md index 9303fa0d..4aa27411 100644 --- a/docs/placeholders.md +++ b/docs/placeholders.md @@ -1,17 +1,15 @@ image(6) ---- +--- # 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 | -|------------------|-----------------------------------------------------------------------------|------------------------------------------------------------------------| +| ---------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------- | | \ | None\* | Use server expansion for PAPI | | \ | %neptune_queued% | Get the number of players in queue | | \ | %neptune_in-match% | Get the number of players in matches | @@ -27,7 +25,7 @@ ## In Queue | Plugin | PlaceholderAPI | Description | -|-----------------|----------------------------|-----------------------------------------------------------------------| +| --------------- | -------------------------- | --------------------------------------------------------------------- | | \ | %neptune_kit% | The display name of the kit the player is playing on | | \ | %neptune_maxPing% | The maximum ping allowed by the player in their settings | | \