Greedy Compass

What is this?


This is a plugin (for paper servers) that allows a player to track the location of another player with a compass. The catch is, they have to pay a little fee to track a player..

Cool, but how do I use this?


Simply just download the plugin and put it onto your plugins folder.

Commands:

• /track <player_name> - Allows you to track another player.

Configuration

To change any settings of this plugin you can edit the config file located at plugins/GreedyCompass/config.yml

How your config.yml should look like:

# configuration (config.yml)
# ===========================

# Duration of the compass tracking in seconds (16 minutes = 960 seconds)
compass-duration: 960

enable-streak-reset: true
streak-reset-days: 4

streak-costs:
  1: "10, DIAMOND"
  2: "10, DIAMOND"
  3: "20, GOLD_INGOT"
  4: "30, EMERALD"
  5: "40, DIAMOND_BLOCK"
  6: "50, EMERALD_BLOCK"
  7: "60, NETHERITE_INGOT"
  default-increment: "10, NETHERITE_INGOT"

gui:
  title: "<dark_gray>Confirm Tracking Purchase</dark_gray>"
  confirm-button: "<green><bold>CONFIRM PURCHASE</bold></green>"
  deny-button: "<red><bold>CANCEL</bold></red>"
  info-button: "<gold><bold>Tracking Details</bold></gold>"

messages:
  prefix: "<gold>[GreedyCompass]</gold> "
  no-permission: "<red>You do not have permission to run this command.</red>"
  player-only: "<red>Only players can execute this command.</red>"
  player-not-found: "<red>That player cannot be found or is offline.</red>"
  cannot-track-self: "<red>You cannot track yourself!</red>"
  not-enough-items: "<red>You do not have enough items! Requires: <yellow><cost> <item></yellow>.</red>"
  started-tracking: "<green>Tracking session activated for <white><target></white>!</green>"
  dimension-info: "<yellow>Target <white><target></white> is currently located in the <light_purple><dimension></light_purple> dimension.</yellow>"
  dimension-change: "<gold>Alert: <white><target></white> has jumped to the <light_purple><dimension></light_purple> dimension!</gold>"
  expired: "<red>Your tracking tracking compass has been expired.</red>"

• compass-duration: 960 - Defines the expiry of the compass in seconds (After this duration, the compass will be removed from the players inventory.

• enable-streak-reset: true - This is used to determine if the interest on cost should be reset to 10 diamonds after a specific amount of days (streak-reset-days: 4)

• streak-reset-days: 4 - The amount of days to wait for resetting the interest on the cost (streak)

streak-costs:
  1: "10, DIAMOND"
  2: "10, DIAMOND"
  3: "20, GOLD_INGOT"
  4: "30, EMERALD"
  5: "40, DIAMOND_BLOCK"
  6: "50, EMERALD_BLOCK"
  7: "60, NETHERITE_INGOT"
  default-increment: "10, NETHERITE_INGOT"

This section of the config Defines the cost to buy a tracker and the change of cost for each time a player buys a tracker (For example, in streak-costs: if number 5 is set to 5: "40, DIRT" then at the 5th time of buying the tracker, you would have to pay 40 dirt.

default-increment: is what determines the cost amount after the 7th time (Example, if the cost to buy a tracker for the 7th time is 60 netherite ingots then at the 8th time the tracker would cost 70 ingots (Assuming the default-increment is set to 10: default-increment: "10, NETHERITE_INGOT") and increases by 10 after.

(NOTE: the material in 7: line and default-increment: line must be the same to work.)

gui:
  title: "<dark_gray>Confirm Tracking Purchase</dark_gray>"
  confirm-button: "<green><bold>CONFIRM PURCHASE</bold></green>"
  deny-button: "<red><bold>CANCEL</bold></red>"
  info-button: "<gold><bold>Tracking Details</bold></gold>"

This section defines the text and its style on the chest GUI when a player buys a tracker.
For example, if the title config is this: title: "<dark_gray>Confirm Tracking Purchase</dark_gray>" then the text in the GUI would appear as "Confirm Tracking Purchase" in dark grey.

If you wish to change any of the text and/or its formatting (such as, add underline, etc.) generate your text using this formatter (I did not develop this website)

messages:
  prefix: "<gold>[GreedyCompass]</gold> "
  no-permission: "<red>You do not have permission to run this command.</red>"
  player-only: "<red>Only players can execute this command.</red>"
  player-not-found: "<red>That player cannot be found or is offline.</red>"
  cannot-track-self: "<red>You cannot track yourself!</red>"
  not-enough-items: "<red>You do not have enough items! Requires: <yellow><cost> <item></yellow>.</red>"
  started-tracking: "<green>Tracking session activated for <white><target></white>!</green>"
  dimension-info: "<yellow>Target <white><target></white> is currently located in the <light_purple><dimension></light_purple> dimension.</yellow>"
  dimension-change: "<gold>Alert: <white><target></white> has jumped to the <light_purple><dimension></light_purple> dimension!</gold>"
  expired: "<red>Your tracking tracking compass has run out of power and expired.</red>"

This section of the config is used to change the messages/prefix of the plugin.
These are not recommended to change.