πŸƒβ€β™‚οΈParkour

Let players show their jumping skills.

New documentation for this resource under construction.

Description

An extensive arcade game, where the player has to pass the map in the shortest time. During the journey, various obstacles are waiting for adventurers.

Prerequisites

Before you run Parkour plugin on your server, there are a few requirements that you should check.

  • Ensure you are using Minecraft version 1.8.8 or later. (Versions below 1.8.8 are not supported!)

  • Your server has installed Java8 or later.

  • Make sure that you have already installed plugin TheCore

Installation

  1. Unzip downloaded file.

  2. Put Parkour.jar into plugins folder at your server.

Downloaded .zip file contains more .jar file depending on the server version. Choose the one that fits your server.

  1. Restart your server.

  2. Done

Commands & Permissions

Command DescriptionCommandPermission

Player section

Help

/Parkour Help [Player]

Parkour.Help.Player

Information about Parkour

/Parkour Info [Player]

Parkour.Info.Player

Join the Map

/Parkour Join <MapName>

Parkour.Map.Join.Command

Leave the Map

/Parkour Leave

Parkour.Map.Leave.Command

List of Maps

/Parkour List [Category/Difficulty] [Name]

Parkour.Map.List.Command

Profile

/Parkour Profile

Parkour.Profile.

Join the Event

/Parkour Event Join

Parkour.Event.Join

Leave the Event

/Parkour Event Leave

Parkour.Event.Leave

Personal Stats

/Parkour Stats Me [MapName]

Parkour.Stats.Personal

Player Stats

/Parkour Stats Player <PlayerName/UUID> [Rank/MapName]

Parkour.Stats.Target

Map Stats

/Parkour Stats Map <MapName>

Parkour.Stats.Map

Summary Stats

/Parkour Stats Summary <Type>

Parkour.Stats.Summary

Rate Map

/Parkour Map Rate <MapName> <Rating>

Parkour.Map.Rate

Admin section

Advanced Help

/Parkour Help Admin

Parkour.Help.Admin

Advanced Information

/Parkour Info Admin

Parkour.Info.Admin

Set SpawnPoint

/Parkour GlobalLocation SetSpawnPoint

Parkour.GlobalLocation.SpawnPoint.Create

Set EventLobby

/Parkour GlobalLocation SetEventLobby

Parkour.GlobalLocation.EventLobby.Create

Start the Event

/Parkour Event Start [MapName]

Parkour.Event.Start

Create Map

/Parkour Map Create <MapName>

Parkour.Map.Create

Remove Map

/Parkour Map Remove <MapName>

Parkour.Map.Remove

Set StartPoint

/Parkour Map SetStartPoint <MapName>

Parkour.Map.Point.Start

Set FinishPoint

/Parkour Map SetFinishPoint <MapName>

Parkour.Map.Point.Finish

Set CheckPoint

/Parkour Map SetCheckPoint <MapName> <Order>

Parkour.Map.Point.CheckPoint.Set

Add CheckPoint

/Parkour Map AddCheckPoint <MapName>

Parkour.Map.Point.CheckPoint.Add

Remove CheckPoint

/Parkour Map RemoveCheckPoint <MapName> [Order]

Parkour.Map.Point.CheckPoint.Remove

Set LeaveActionPoint

/Parkour Map SetLeaveActionPoint <MapName>

Parkour.Map.Point.Action.Leave

Set FinishActionPoint

/Parkour Map SetFinishActionPoint <MapName>

Parkour.Map.Point.Action.Finish

Link Figure

/Parkour Map LinkFigure <MapName>

Parkour.Map.Point.Figure

Unlink Figure

/Parkour Map UnlinkFigure <MapName>

Parkour.Map.Point.Figure

Switch to the SetUp Mode

/Parkour Map SetUp <MapName>

Parkour.Map.SetUp

Open Map Settings

/Parkour Map Settings <MapName>

Parkour.GUI.Settings.Open.One

Enable Maintenance

/Parkour Maintenance Enable <MapName>

Parkour.Map.Maintenance.Enable

Disable Maintenance

/Parkour Maintenance Disable <MapName>

Parkour.Map.Maintenance.Disable

Reload plugin

/Parkour Reload [All]

Parkour.Reload.All

Reload locale

/Parkour Reload Locale

Parkour.Reload.Locale

Reload options

/Parkour Reload Options

Parkour.Reload.Options

Reload map

/Parkour Reload Map <MapName>

Parkour.Reload.Map

Place Personal Board

/Parkour Board Personal Place

Parkour.Board.Personal.Place

Remove Personal Board

/Parkour Board Personal Remove

Parkour.Board.Personal.Remove

Place Map Board (Banner)

/Parkour Board Map <MapName> Place Banner

Parkour.Board.Map.Banner.Place

Remove Map Board (Banner)

/Parkour Board Map <MapName> Remove Banner

Parkour.Board.Map.Banner.Remove

Place Map Board (Podium)

/Parkour Board Map <MapName> Place Podium <Order>

Parkour.Board.Map.Podium.Place

Remove Map Board (Podium)

/Parkour Board Map <MapName> Remove Podium <Order>

Parkour.Board.Map.Podium.Remove

Remove Map Board (Sign)

/Parkour Board Map <MapName> Remove Sign <Order>

Parkour.Board.Map.Sign.Remove

Place Leader Board (Banner)

/Parkour Board Summary Place Banner <Type>

Parkour.Board.Leader.Banner.Place

Remove Leader Board (Banner)

/Parkour Board Summary Remove Banner <Type>

Parkour.Board.Leader.Banner.Remove

Place Leader Board (Podium)

/Parkour Board Summary Place Podium <Type> <Order>

Parkour.Board.Leader.Podium.Place

Remove Leader Board (Podium)

/Parkour Board Summary Remove Podium <Type> <Order>

Parkour.Board.Leader.Podium.Remove

Remove Leader Board (Sign)

/Parkour Board Summary Remove Sign <Type> <Order>

Parkour.Board.Leader.Sign.Remove

Create section

/Parkour Section Create <CustomName>

Parkour.Section.Create

Delete section

/Parkour Section Delete <CustomName>

Parkour.Section.Delete

Add component to section

/Parkour Section Component Add <CustomName> <Type>

Parkour.Section.Component.Add

Remove component from section

/Parkour Section Component Add <CustomName> <Type>

Parkour.Section.Component.Remove

Set section switch time

/Parkour Section UpdateSwitchTime <CustomName> <Amount>

Parkour.Section.SwitchTime

Reset All Player Stats

/Parkour Stats Player <PlayerName/UUID> Reset

Parkour.Stats.Target.Remove.All

Reset Player's Rank

/Parkour Stats Player <PlayerName/UUID> Rank Reset

Parkour.Stats.Target.Remove.Rank

Reset Player's Map Stats

/Parkour Stats Player <PlayerName/UUID> <MapName> Reset

Parkour.Stats.Target.Remove.Map

Reset Map Stats

/Parkour Stats Map <MapName> Reset

Parkour.Stats.Map.Remove

Open Settings

/Parkour Settings

Parkour.GUI.Settings.Open

Additional Permissions

DescriptionPermissionCovers

Player

Parkour.Player

Base player's actions

Admin

Parkour.Admin

Complete package of all permissions

Map

Parkour.Map.*

Permissions of the SetUp Map

Map Author

Parkour.Map.Author

Author's Permissions of the SetUp Map

Maintenance

Parkour.Maintenance.*

Permissions of Maintenance

Board

Parkour.Board.*

Permissions of Board

Board Sections

Parkour.Section.*

Permissions of Board Sections

Reload

Parkour.Reload.*

Permissions of Reload

Event

Parkour.Event.*

Permissions of Event

Stats

Parkour.Stats.*

Permissions of Stats

Map List from HotBar

Parkour.Map.List.Interact

Create Sign

Parkour.Map.Sign.Create

Break Sign

Parkour.Map.Sign.Destroy

Create Map Sign

Parkour.Board.Map.Sign.Place

Create Leader Sign

Parkour.Board.Leader.Sign.Place

Join the map by Figure

Parkour.Map.Join.Figure

Join the map by Sign

Parkour.Map.Join.Sign

Join the map by Step

Parkour.Map.Join.Step

Join the map by GUI

Parkour.Map.Join.Gui

Join the map using ByPass

Parkour.Map.Join.ByPass

SetUp the map using ByPass

Parkour.Map.Author.ByPass

Localized commands

This plugin brings ability to fully manage commands. As a main command, /Parkour should not be used. You can use any alternative.

Each command has own aliases to make the usage faster.

#CommandConfigurationFile: Command/Parkour.yml
Base:
  Name: "Parkour"
  Alias:
    - "pa"
Component:
  GlobalLocation:
    Base:
      Name: "GlobalLocation"
      Alias:
      - gl

Copy

Configuration

Detailed explanation of variables at configuration files.

Config

Automatic Updates

Resource supports automatic (startup) updates. You can enable or disable them. If disabled, you will only receive message about new version.

Localization

Fully customizable localized messages. Just make duplicate of EN.yml file(In the same folder!). Rename it and write the name of the file into config.yml.

Example of the Locale file:

#LocaleFile: EN.yml
Prefix:
  Base: "&3&lParkour &6\u2771"
  ...

Copy

#LocaleFile: SK.yml (Slovak)
Prefix:
  Base: "&3&lParkur &6\u2771"
  ...

Copy

Multi Localization

Plugin is able to hold different localisations at the same time. It’s up to player, which localisation wants to display.

Secondary localizations do not have to contain all translations. In case of secondary translation does not contain requested path, the primary file is used to fetch data.

#Config:
Locale:
  Primary: EN
  Secondary:
  - SK
  - CZ
  ...

Copy

Storage

Space where to save required data. Supported storages: MySQL and SQLite

If you prefer MySQL Storage before SQLite, you need to fill variables at config.yml.

There is required that ProfileStorage and this plugin is using the same source of storage!

Analytics

Plugin sends anonymous data such as version of this resource, your server version and addition data of configuration. These data will help me in future development. All requests are asynchronous, so it has no impact on server's performance.

If you don't want to share these data, you can easily disable it.

Analytics:
  Active: false

Copy

Data collected from your server about Parkour

{
   "Options":{
      "Addon":{
         "TimerVisibility":true,
         "CompassNavigation":true,
         "ContactDamage":false,
         "JoinByStep":true
      },
      "Economy":{
         "VaultWrapper":true
      },
      "Board":{
         "Personal":{
            "Type":"BANNER"
         },
         "Leader":{
            "Type":"NONE"
         }
      },
      "Stats":{
         "Limit":3
      },
      "Event":{
         "Activity":true,
         "BossBar":true,
         "TimeToJoin":60,
         "MinPlayerCount":2,
         "Mode":"MANUAL"
      },
      "GUI":{
         "PreMapList":"NONE"
      },
      "BungeeCord":{
         "Activity":false,
         "ExploringHotBar":false
      },
      "Visual":{
         "MeanTime":{
            "Activity":true
         },
         "ScoreBoard":{
            "Exploring":false,
            "Eventing":true,
            "Playing":true
         },
         "BroadCast":{
            "ReachNewRank":true,
            "FinishMap":true,
            "BeatMapTime":true,
            "EventAction":true
         },
         "Map":{
            "Rating":{
               "Range":5,
               "Activity":true,
               "TimeLimit":5
            }
         }
      }
   }
}

Copy

Options

Options file is divided to sections.

Everyting is configurable in-game via command /Parkour Settings

Addons

By enabling or modifying add-ons, Parkour becomes more attractive to players.

  • CompassFinishNavigation - Compass at player's inventory shows direction to the finish of the map.

  • TimerVisibility - At enabling, current time is shown at action bar.

  • JoinByStep - Player can join the map by stepping on the start point of the map.

  • FakeContactDamage - Player can receive fake damage, while he step on cactus or similar block.

  • InteractiveItem - Collection of items(Door, Lever, Button), which player can interact while playing the map.

BungeeCord

This mode is primary determined for bigger server network, while Parkour is a separated server.

At this section, you can specify channel how to communicate with BungeeCord. Also name of lobbies, where player is moved at leaving the server, are listed here.

By enabling this mode, player receives special items into hotbar at joining the server.

These items are able to obtain at common server by disabling bungee mode and enabling ExploringHotBar flag!

Command

Commands while player is in the map are restricted. You need to specify commands, which can be invoked.

DefaultMapData

At map creation, these values are copied into map file. Set once, use more time.

Only one value is not copied. Author section. Here you can set limit, how much maps can player create.

Visual

Section represents components displayed at chats and boss bars.

Map

Here you can define TimeFormat used at parsing time to action bar or leaderboards.

HINT: If you want display hours use format: HH:mm:ss.SSS

BroadCast

Each significant action is broadcasted to all players. You can disable it, or you can restrict worlds, where messages won't be displayed.

ScoreBoard

These boards shows current stats in order to player's state. You can disabled them, or you can restrict worlds, where Exploring scoreboard won't be displayed.

Board

Boards or LeaderBoards are used to display personal or summary stats. Nicely fit the server lobby scene.

There are three types of boards:

  • BANNER - One leader-one line.

  • PODIUM_ARMOR_STAND - Each leader(place) has own location. Colored ArmorStand with player's head.

  • PODIUM_PLAYER - Each leader(place) has own location. NPC with leader's skin.

  • SIGN - Each leader(place) has own location. Skull placed above the sign.

How to create board is explained below.

Event

Event system is prepared as a competition between players at the same time. They have X seconds to join the map. When all participated players finish the map, system will find the best ones and will give them rewards.

Seting up the first Map

HINT Use Tab at completing commands.

Prerequisites

  1. Create lobby point. Find suitable place, fix your position and type /Parkour GlobalLocation SetSpawnPoint.

  2. Build the whole map.

  3. (Optional) Select board type for map leaders using /Parkour Settings -> Global -> Board -> Summary -> Type. Choose one and click on wooden door.

  • Reload the plugin using /Parkour Reload [All]

  1. (Optional) Create podiums or style place for boards.

Map

  1. Creating new map. Choose suitable name and type /Parkour Map Create <Name>.

  2. Join the SetUp mode using /Parkour Map SetUp <Name>. Also you can use commands to save locations, but there is much more simple. You will see πŸ˜ƒ

  3. Start point. Scroll you hotbar to Start item. Find suitable place, your position and right click with item(into the air).

  4. The same for finish and checkpoints and action points.

  5. Reload the map using /Parkour Reload Map <MapName>

  6. Enabling the map. Each map's modification requires Maintenance mode, so we need to quit it using /Parkour Maintenance Disable <MapName>.

  7. Done, you can join your first map.

Personal Board

  1. Select board type using /Parkour Settings -> Global -> Board -> Personal -> Type.

  • Reload the plugin using /Parkour Reload [All]

  1. Find suitable place, fix your position and type /Parkour Board Personal Place

  2. Done, you should see Personal Board

Map Leader Board

As default top 3 players of each map can be displayed at LeaderBoards.

Prerequisites

Select board type using /Parkour Settings -> Global -> Board -> Leader -> Type.

Banner

  1. Find suitable place, fix your position and type /Parkour Board Map <MapName> Place Banner

  2. Done, to see the Banner, reload map using /Parkour Reload Map <MapName>

Podium

  1. Find suitable place for the best(1st) player, fix your position and type /Parkour Board Map <MapName> Place Podium 1

  • Repeat for the next two podiums, just find new place and change the last argumennt from 1 to 2 and 3.

  1. Done. To see podiums, reload map using /Parkour Reload Map <MapName>

Sign

  1. Find suitable place for the best(1st) player, place sign and type

    • **Parkour**

    • MapName

    • Position

  • Repeat for the next two podiums, just find new place and change the position from 1 to 2 and 3.

  1. (Optional) Place head(skull item) above the sign to see textures of the player.

  2. Done. To see podiums, reload map using /Parkour Reload Map <MapName>

Summary Leader Board

There is collected more types of stats. To display them at podiums/banner can take too much place at the server. Instead of that, you can create just one place and let system to change boards with stats in definded intervals.

Board Sections

At first we need to create section, which ensures changing stat components in defined intervals.

  1. Create section using /Parkour Section Create <Name>

  2. Add stat component to section using /Parkour Section Component Add <Name> <Type>

  3. (Optional) Change default interval duration using /Parkour Section UpdateSwitchTime <Name> <Time>

Available component types:

  • TheHighestRank

Board

Banner

  1. Find suitable place, fix your position and type /Parkour Board Summary Place Banner <ComponentType>

  2. Done, to see the Banner, reload map using /Parkour Reload [All]

Podium

  1. Find suitable place for the best(1st) player, fix your position and type /Parkour Board Summary Place Podium <ComponentType> 1

  • Repeat for the next two podiums, just find new place and change the last argumennt from 1 to 2 and 3.

  1. Done. To see podiums, reload map using /Parkour Reload [All]

Sign

  1. Find suitable place for the best(1st) player, place sign and type

    • **Parkour**

    • TheHighestRank

    • Position

  • Repeat for the next two podiums, just find new place and change the position from 1 to 2 and 3.

  1. (Optional) Place head(skull item) above the sign to see textures of the player.

  2. Done. To see podiums, reload map using /Parkour Reload [All]

Reward

The main point of Reward Repository is that one reward can be used at different maps at the same time. One change of reward affects all maps, no need to manage each map's rewards separately.

Using simple in-game GUI, rewards are created in a few minutes!

For more details please, check reward setup from AdventSeason.

PlaceholderAPI

Plugin offers ability to obtain data via placeholderAPI.

Personal stats

  • %parkour_personal_stats_map_<MapName>_time% - Parsed time. (00:04.243)

  • %parkour_personal_stats_map_<MapName>_time_raw% - Raw time in milliseconds (4243)

  • %parkour_personal_stats_map_<MapName>_position% - Position at map

  • %parkour_personal_stats_map_<MapName>_position_raw% - Position at map. (If does not exists, max int value)

Map stats

  • %parkour_stats_map_<MapName>_time_<Order>% - Parsed time of player at requested position

  • %parkour_stats_map_<MapName>_name_<Order>% - Name(Nick) of player at requested position

Counts

  • %parkour_map_count_all% - Count of all maps

  • %parkour_map_count_open% - Count of opened maps

  • %parkour_map_count_maintenance% - Count of maps under maintenance

  • %parkour_map_count_c_<Category>% - Count of maps with requested category

  • %parkour_map_count_d_<Diffculty>% - Count of maps with requested difficulty

Player (Deprecated, may be removed at following updates)

  • %parkour_rank% - Current rank of the player

  • %parkour_rank_point_amount% - Current amount of rank points at player's account

  • %parkour_next_rank% - Next rank for the player

  • %parkour_next_rank_point_amount% - Amount of rank points required to reach new rank

  • %parkour_map_completed% - Count of completed maps

  • %parkour_map_uncompleted% - Count of uncompleted maps

Player NEW!

  • %parkour_profile_rank% - Current rank of the player

  • %parkour_profile_rank_point_amount% - Current amount of rank points at player's account

  • %parkour_profile_next_rank% - Next rank for the player

  • %parkour_profile_next_rank_point_amount% - Amount of rank points required to reach new rank

  • %parkour_profile_map_completed_count% - Count of completed maps

  • %parkour_profile_map_completed_count_c_<Category>% - Count of completed maps at requested category

  • %parkour_profile_map_completed_count_c_<Diffculty>% - Count of completed maps at requested difficulty

  • %parkour_profile_map_uncompleted_count% - Count of uncompleted maps

  • %parkour_profile_map_uncompleted_count_c_<Category>% - Count of uncompleted maps at requested category

  • %parkour_profile_map_uncompleted_count_c_<Diffculty>% - Count of uncompleted maps at requested difficulty

  • %parkour_profile_map_daily_challenge_count% - Count of completed maps in a day

  • %parkour_profile_map_favourite_name% - Name of favourite map

  • %parkour_profile_map_favourite_time% - Reached time at favourite map

  • %parkour_profile_map_favourite_count% - Count of completions at favourite map

  • %parkour_profile_map_best_name% - Name of your personal best map

  • %parkour_profile_map_best_time% - Time at your personal best map

Miscellaneous

  • %parkour_version% - Version of the plugin

FAQ

  • Cannot interact with Lobby/Map/SetUp items in HotBar.

    • This situation occurs when the player has not got active Adventure Mode. (Some plugins that managing worlds, can switch player's gamemode e.g. Multiverse-Core, MultiWorld...)

    • One of the solution is to set Adventure Mode for the whole world where Parkour(Lobby/Map) is used

Last updated