From 2227b94a63f94f1cf982cbadf65a3f0b67657e5c Mon Sep 17 00:00:00 2001 From: A5H73Y Date: Thu, 9 Jun 2022 22:47:20 +0100 Subject: [PATCH] Reintroduce administration page to collate admin commands Updates to docs --- docs/_sidebar.md | 1 + docs/index.md | 2 - docs/tutorials/administration.md | 85 +++++++++++++++++++++++++++ docs/tutorials/parkour-autostart.md | 2 +- docs/tutorials/parkour-config.md | 43 ++++++++++---- docs/tutorials/parkour-courses.md | 41 ++++--------- docs/tutorials/parkour-database.md | 11 +--- docs/tutorials/parkour-kits.md | 4 +- docs/tutorials/parkour-level-ranks.md | 4 ++ docs/tutorials/parkour-lobby.md | 8 +-- docs/tutorials/parkour-players.md | 3 +- 11 files changed, 138 insertions(+), 66 deletions(-) create mode 100644 docs/tutorials/administration.md diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 1f035cd6..aa1d8b92 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -21,6 +21,7 @@ - [ParkourModes](tutorials/parkour-modes.md) - [Level & Ranks](tutorials/parkour-level-ranks.md) - [AutoStarts](tutorials/parkour-autostart.md) + - [Administration](tutorials/administration.md) - [Challenge Mode](tutorials/challenge-mode.md) - [Sign Commands](tutorials/sign-commands.md) - [Leaderboard Database](tutorials/parkour-database.md) diff --git a/docs/index.md b/docs/index.md index 227a4a9c..0ad16c5e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,8 +25,6 @@ Parkour allows you to create unlimited Courses, each with unlimited checkpoints, Whether you are setting the plugin up as a mini-game, or as a dedicated Parkour server, the powerful configuration will allow you to choose exactly how you want the plugin to work. A 'ParkourKit' is a set of customisable Materials which will add a whole new level of fun to each Course. -Parkour uses a database to store all the leaderboards for each Course, allowing for powerful and customisable results. By default, the plugin will create a SQLite database locally in the `plugins` folder, in a folder named `sqlite-db`, however if you wish to use a MySQL server of your choice, this can be configured in the `config.yml`. - ## Featured Servers These are servers that utilise the Parkour plugin well for you to try it out. diff --git a/docs/tutorials/administration.md b/docs/tutorials/administration.md new file mode 100644 index 00000000..adce5277 --- /dev/null +++ b/docs/tutorials/administration.md @@ -0,0 +1,85 @@ +Administration +====== + +## Delete Commands + +Using the delete command, you are able to delete various things. Using the syntax: `/pa delete (choice) (argument)`. + +All of which require conformation before the action is completed. + +### Delete a Course + +If you delete a Course it will remove all information stored on the server about it, including all references from the database so only use as a last resort. If preferred, you can reset a Course which will keep its structure (start location & checkpoints), but reset all of its stats and leaderboards. + +![Deleting Course](https://i.imgur.com/apa5azA.png "Deleting Course") + +![Delete Confirm](https://i.imgur.com/8ucihM7.png "Delete Confirm") +_Command: `/pa delete course (course)`_ + +### Delete a Checkpoint + +If you want to delete a checkpoint, it will start with the highest number and decrease to the lowest, for safety reasons. For example if your Course has 5 checkpoints, and you enter `/pa delete checkpoint (course)` it will ask if you want to delete checkpoint 5, if you execute the command again it will ask if you want to delete checkpoint 4, etc. + +Note that you may want to overwrite a checkpoint if it needs moving, instead of deleting many. For example if you had 5 checkpoints and wanted to move the location of checkpoint 2, you can enter `/pa create checkpoint (course) 2` in the desired location. +_Command: `/pa delete checkpoint (course)`_ + +### Delete a Lobby + +If there are any Courses linked to this lobby, it will error and present a list of Courses still dependent on this lobby. You must link these Courses to a different Lobby before you are able to delete it. + +![Delete Validation](https://i.imgur.com/wCO9jrU.png "Delete Validation") + +_Command: `/pa delete lobby (lobby)`_ + +### Delete a ParkourKit + +If there are any Courses linked to the ParkourKit, it will error and present a list of Courses still dependent on this kit. You must link these Courses to a different ParkourKit before you are able to delete it. + +_Command: `/pa delete kit (kit)`_ + +### Delete a ParkourRank + +You are able to delete a ParkourRank for the ParkourLevel provided which will remove the ability for players to unlock it. Note that Players which have already unlocked it will not be affected. + +_Command: `/pa delete rank (level)`_ + +### Delete a Leaderboard Row + +You can quickly delete the desired row from the specified Course leaderboard. Note that it's recommended to use [reset player]() or [reset player leaderboard]() first to remove any undesirable Player's leaderboards. + +This will simply remove the row from the database, so the leaderboards will be recalculated afterwards. + +_Command: `/pa delete leaderboardrow (row)`_ + +## Reset Commands + +Using the reset command, you are able to reset a Course, Player, Leaderboard or Prize. Using the syntax: `/pa reset (choice) (argument)`. + +All operations will have to be confirmed or cancelled before the change is made. + +![Reset Command](https://i.imgur.com/r1gzO05.png "Reset Command") + +### Reset a Course + +This will delete all the statistics stored, which includes leaderboards and various Parkour attributes. This will NOT affect the spawn / checkpoints. +_Command: `/pa reset course (course)`_ + +### Reset a Player + +This will delete all their leaderboards across all Courses and delete all various Parkour attributes. +_Command: `/pa reset player (player)`_ + +### Reset a Course Leaderboard + +This action will remove **all** the times for the specified Course. +_Command: `/pa reset leaderboard (course)`_ + +### Reset a Player Course Leaderboard + +This action will remove the specified Player's times from a specified Course, when provided. +_Command: `/pa reset leaderboard (course) [player]`_ + +### Reset a Prize + +This will reset all the prizes for a Course, causing it to use the default prize specified in the `config.yml`. +_Command: `/pa reset prize (course)`_ diff --git a/docs/tutorials/parkour-autostart.md b/docs/tutorials/parkour-autostart.md index 4b446253..df876b80 100644 --- a/docs/tutorials/parkour-autostart.md +++ b/docs/tutorials/parkour-autostart.md @@ -15,6 +15,6 @@ _Command: `/pa create autostart (course)`_ ### Delete an AutoStart -Deleting an AutoStart is simple, with the correct permission you are able to break the pressure plate which will delete the AutoStart. +Deleting an AutoStart is simple, with the correct permission you are able to break the pressure plate which will automatically delete the AutoStart. If you wish to change the pressure plate to a different type, SNEAK and break the pressure plate to prevent deleting the AutoStart, and place a new pressure plate in its place. diff --git a/docs/tutorials/parkour-config.md b/docs/tutorials/parkour-config.md index 0ab229a4..bd50e6cf 100644 --- a/docs/tutorials/parkour-config.md +++ b/docs/tutorials/parkour-config.md @@ -84,7 +84,10 @@ OnCourse: PreventFireDamage: true # Should the Player only be allowed to achieve checkpoints sequentially (1 - 2 - 3...) # Or can they be allowed to skip checkpoints (1 - 3 - 4...) - SequentialCheckpoints: true + SequentialCheckpoints: + Enabled: true + # Notify the Player when they've achieved a checkpoint which was non-sequential (i.e. they've missed a checkpoint) + AlertPlayer: true # Should the Players have to be sneaking to activate the Parkour Tools SneakToInteractItems: true # Should achieving the final Checkpoint trigger the Course finish for the Player @@ -240,7 +243,7 @@ ParkourModes: # Should the velocity be inverted (teleported forwards instead of backwards) Invert: false # Seconds delay before being able to fire again - Delay: 1 + SecondCooldown: 1 # Amount of force received from the rocket launching LaunchForce: 1.5 @@ -248,14 +251,25 @@ ParkourModes: # Choose the durations for each stage, and choose which will be presented in a Title DisplayTitle: FadeIn: 5 - Stay: 20 FadeOut: 5 - JoinCourse: true - Checkpoint: true - RewardLevel: true - Death: true - Leave: true - Finish: true + JoinCourse: + Enabled: true + Stay: 20 + Checkpoint: + Enabled: true + Stay: 20 + RewardLevel: + Enabled: true + Stay: 20 + Death: + Enabled: true + Stay: 20 + Leave: + Enabled: true + Stay: 20 + Finish: + Enabled: true + Stay: 20 # All the options for AutoStarts AutoStart: @@ -337,7 +351,7 @@ Sounds: Pitch: 1.75 ReloadRocket: Enabled: true - Sound: TODO // TODO + Sound: ENTITY_PHANTOM_HURT Volume: 0.1 Pitch: 1.75 @@ -366,6 +380,8 @@ ParkourRankChat: # Everything else Other: + # Should the Plugin use AutoTabCompletion - this is highly recommended + UseAutoTabCompletion: true # Should the Plugin check for updates on start up CheckForUpdates: true # Should certain events (delete / reset) be logged to a file @@ -420,7 +436,7 @@ Other: OnServerShutdown: BackupFiles: false - # Should the Player's Parkour Infomation be deleted if Parkour detects they've been banned + # Should the Player's Parkour Information be deleted if Parkour detects they've been banned # For example if a Player has been banned for cheating in many Courses, all of their times will be deleted automatically upon banning OnPlayerBan: ResetParkourInfo: false @@ -429,16 +445,19 @@ Other: OnSetPlayerParkourLevel: UpdateParkourRank: true - # When the Player takes Void damage, should the Player be teleported to the closest Lobby + # When the Player takes Void damage, should the Player be teleported to the closest Lobby when not on a Course OnVoid: TeleportToLobby: false # Each Parkour compatible plugin config Plugin: + # BountifulAPI is required for titles and action bar messages on servers before 1.11 BountifulAPI: Enabled: true + # Vault is required to use economy functionality Vault: Enabled: true + # Allows Parkour to offer external placeholders, also allows using placeholderapi values in multiple places PlaceholderAPI: Enabled: true # How many seconds should database results be cached for diff --git a/docs/tutorials/parkour-courses.md b/docs/tutorials/parkour-courses.md index 91522e35..98dc3996 100644 --- a/docs/tutorials/parkour-courses.md +++ b/docs/tutorials/parkour-courses.md @@ -253,43 +253,24 @@ _They **must** be uppercase._ When a Player joins a Course you are able to give them items which they can use throughout the Course. An example could be an Elytra to help navigate the Course, instead of relying on a chest / another plugin. -The items can be given a label to display in the inventory. The items can be made unbreakable by providing a boolean as the final argument. +For the easiest convenience, you are able to hold the ItemStack you would like to set as a Join Item in your main hand, then run the command which will save and load the ItemStack exactly as presented. + +Optionally, additional arguments can be provided to specify the Material, amount and an optional label to display in the inventory. The items can be made unbreakable by providing a boolean as the final argument. ![Add JoinItem](https://i.imgur.com/ZQeDY5K.png "Add JoinItem") ![Add JoinItem Inventory](https://i.imgur.com/WoYOdxb.png "Add JoinItem Inventory") -_Command: `/pa addjoinitem (course) (material) (amount) [label] [unbreakable]`_ -_Example: `/pa addjoinitem tutorial ELYTRA 64`_ - -[//]: # (add something here about the ability to just to /pa addjoinitem course, then it will add whatever is in their hand) - -## Resetting Course Data - -### Reset a Course - -This will delete all the statistics stored, which includes leaderboards and various Parkour attributes. This will NOT affect the spawn / checkpoints. -_Command: `/pa reset course (course)`_ - -### Reset a Prize - -This will reset all the prizes for a Course, causing it to use the default prize specified in the `config.yml`. -_Command: `/pa reset prize (course)`_ - -## Deleting Course Data - -### Delete a Course - -If you delete a Course it will remove all information stored on the server about it, including all references from the database so only use as a last resort. If preferred, you can reset a Course which will keep its structure (start location & checkpoints), but reset all of its stats and leaderboards. +_Command: `/pa addjoinitem (course) [material] [amount] [label] [unbreakable]`_ +_Example 1: `/pa addjoinitem tutorial`_ +_Example 2: `/pa addjoinitem tutorial ELYTRA 64`_ -![Deleting Course](https://i.imgur.com/apa5azA.png "Deleting Course") +## Deleting / Resetting Course Data -![Delete Confirm](https://i.imgur.com/8ucihM7.png "Delete Confirm") -_Command: `/pa delete course (course)`_ +[Administration - Reset a Prize](/tutorials/administration?id=reset-a-prize) -### Delete a Checkpoint +[Administration - Reset a Course](/tutorials/administration?id=reset-a-course) -If you want to delete a checkpoint, it will start with the highest number and decrease to the lowest, for safety reasons. For example if your Course has 5 checkpoints, and you enter `/pa delete checkpoint (course)` it will ask if you want to delete checkpoint 5, if you execute the command again it will ask if you want to delete checkpoint 4, etc. +[Administration - Delete a Course](/tutorials/administration?id=delete-a-course) -Note that you may want to overwrite a checkpoint if it needs moving, instead of deleting many. For example if you had 5 checkpoints and wanted to move the location of checkpoint 2, you can enter `/pa checkpoint 2` in the desired location. -_Command: `/pa delete checkpoint (course)`_ +[Administration - Delete a Checkpoint](/tutorials/administration?id=delete-a-checkpoint) diff --git a/docs/tutorials/parkour-database.md b/docs/tutorials/parkour-database.md index b176ef71..2a741cfd 100644 --- a/docs/tutorials/parkour-database.md +++ b/docs/tutorials/parkour-database.md @@ -23,16 +23,9 @@ If you modify the contents of the database, it is strongly suggested stopping th ## Resetting Data -### Reset a Course Leaderboard - -This action will remove **all** the times for the specified Course. -_Command: `/pa reset leaderboard (course)`_ - -### Reset a Player Course Leaderboard - -This action will remove the specified Player's times from a specified Course, when provided. -_Command: `/pa reset leaderboard (course) [player]`_ +[Administration - Reset a Course Leaderboard](/tutorials/administration?id=reset-a-course-leaderboard) +[Administration - Reset a Player Course Leaderboard](/tutorials/administration?id=reset-a-player-course-leaderboard) ## Database Troubleshooting diff --git a/docs/tutorials/parkour-kits.md b/docs/tutorials/parkour-kits.md index 6b56b22c..6abdfe0e 100644 --- a/docs/tutorials/parkour-kits.md +++ b/docs/tutorials/parkour-kits.md @@ -68,9 +68,7 @@ If you want to see the Materials that make up the set, you can add an argument f ## Deleting a ParkourKit -If there are any Courses linked to the ParkourKit, it will error and present a list of Courses still dependent on this kit. You must link these Courses to a different ParkourKit before you are able to delete it. - -_Command: `/pa delete kit (kit)`_ +[Administration - Delete a ParkourKit](/tutorials/administration?id=delete-a-parkourkit) ## The ParkourBlocks diff --git a/docs/tutorials/parkour-level-ranks.md b/docs/tutorials/parkour-level-ranks.md index 825641d5..482824ff 100644 --- a/docs/tutorials/parkour-level-ranks.md +++ b/docs/tutorials/parkour-level-ranks.md @@ -88,3 +88,7 @@ _PlaceholderAPI values will be evaluated._ You can add `%RANK%` to your chat plugin's format, which the Parkour plugin will detect and replace with the Player's ParkourRank. Alternatively, if you use a Chat plugin that supports PlaceholderAPI, you can use the `%parkour_player_rank%` placeholder. + +### Delete ParkourRank + +[Administration - Delete a ParkourRank](/tutorials/administration?id=delete-a-parkourrank) diff --git a/docs/tutorials/parkour-lobby.md b/docs/tutorials/parkour-lobby.md index b9ed4651..3d83d105 100644 --- a/docs/tutorials/parkour-lobby.md +++ b/docs/tutorials/parkour-lobby.md @@ -33,10 +33,4 @@ You are able to move the location of an existing Parkour Lobby by re-entering th ## Delete a Lobby -You can delete a Lobby by using the command `/pa delete lobby (lobby)`. - -If there are any Courses linked to this lobby, it will error and present a list of Courses still dependent on this lobby. You must link these Courses to a different Lobby before you are able to delete it. - -![Delete Validation](https://i.imgur.com/wCO9jrU.png "Delete Validation") - -_Command: `/pa delete lobby (lobby)`_ +[Administration - Delete a Lobby](/tutorials/administration?id=delete-a-lobby) diff --git a/docs/tutorials/parkour-players.md b/docs/tutorials/parkour-players.md index c6d5613d..0f394bfd 100644 --- a/docs/tutorials/parkour-players.md +++ b/docs/tutorials/parkour-players.md @@ -35,5 +35,4 @@ _Command: `/pa setplayer (player) addlevel (value)`_ ## Reset a Player -This will delete all their leaderboards across all Courses and delete all various Parkour attributes. -_Command: `/pa reset player (player)`_ +[Administration - Reset a Player](/tutorials/administration?id=reset-a-player)