Sueta

DiscoverAreas - 1.14+

1.7.0-SNAPSHOT

Discover-able places like in MMORPG.

·Plugin

Artboard 1 copy@0,5x.png

Artboard 3.png

Hi, this is igniss, developer of this plugin. Due to my lack of motivation for fixing the current state of the plugin, there is a plan to rewrite it as a whole. Any problems like bugs or glitches will not be solved unless someone creates a pull request on Github repository. Sorry for this inconvenience and I hope to bring back better and more stable version of this plugin soon. Love, igniss.

Thanks to this plugin, you can add discoverable areas to your server. Using WorldGuard regions you can create different areas with various reward commands, reward experience etc. Once a player enters this region, it will be marked as discovered and he will receive all rewards.

This plugin uses bStats to monitor statistics. Here you can view plugin's statistics.

Warning! Snapshot versions are not final and may not be stable, but are less buggy than betas.
Warning! Support for plugin version older than 1.7.0-SNAPSHOT was fully dropped. The newest version now only supports servers with 1.14 or newer version.

Media

upload_2019-10-31_13-3-6.png
javaw_Rq45y4pDnG.png

Unsupported versions of plugin
1.2.0-B1
1.4.0-B1
1.4.0-B2
1.4.0-B3
1.5.0-B1
1.5.0-B2
1.6.0-SNAPSHOT
1.6.1-SNAPSHOT
1.6.2-SNAPSHOT
1.6.3-SNAPSHOT
Default config.yml
# I strongly recommend keeping this enabled, because I often release beta and snapshot versions
# so you would get notified when the stable version is released
general:
  update-notify: true
  # y   = year   (yy or yyyy)
  #M   = month  (MM)
  #d   = day in month (dd)
  #h   = hour (0-12)  (hh)
  #H   = hour (0-23)  (HH)
  #m   = minute in hour (mm)
  #s   = seconds (ss)
  #S   = milliseconds (SSS)
  #z   = time zone  text        (e.g. Pacific Standard Time...)
  #Z   = time zone, time offset (e.g. -0800)
  date-format: "dd.MM.yy HH:mm:ss"

title:
  on_discover:
    enabled: true
    title: "&a&[email protected]"
    subtitle: "&[email protected]"
    # Values are in seconds
    fadein: 1
    stay: 3
    fadeout: 1
  on_enter:
    enabled: true
    title: "&a&[email protected]"
    subtitle: "&[email protected]"
    # Values are in seconds
    fadein: 1
    stay: 3
    fadeout: 1

messages:
  help:
    - "&6&lDiscoverAreas Help"
    - "&e/area &8- &7shows this help"
    - "&e/area create <region> <name> &8- &7create new discoverable area"
    - "&e/area delete <name> &8- &7remove a discoverable area"
    - "&e/area setexp <name> &8- &7set xp reward for area"
    - "&e/area reset [player] &8- &7remove yours/player's progress"
    - "&e/area setdesc <name> &8- &7set area's new description"
    - "&e/area setsound <name> &8- &7set area's discovery sound"
    - "&e/area command list <area> &8- &7shows all area's reward commands"
    - "&e/area command add <name> &8- &7add new reward command to area"
    - "&e/area command remove <cmd_id> <area> &8- &7remove reward command"
    - "&e/area command edit <cmd_id> <area> &8- &7edit reward command"
  on_discover:
    enabled: true
    messages:
      - "&a&lYou have discovered @area"
      - "&f"
      - "&[email protected]"
  on_enter:
    enabled: false
    messages:
      - "&aYou are entering @area"
  # Leave blank if you want to disable this message
  disabled_menu: "You cannot access this menu, because it is disabled."
  no_permission: "You don't have permission to do this."
  no_areas: "There are no areas to view."

sounds:
  info: "BLOCK_LADDER_HIT"
  success: "ENTITY_VILLAGER_YES"
  error: "ENTITY_VILLAGER_NO"
  warning: "ENTITY_VILLAGER_NO"

menus:
  user:
    enabled: true
    titles:
      nopage: "User menu"
      page: "User menu #@page"
  admin:
    enabled: true
    titles:
      nopage: "Admin menu"
      page: "Admin menu #@page"

gui:
  list:
    admin:
      material: BOOK
      glowing: false
      displayname: "&[email protected]"
      lore:
        - "&fWorld: &[email protected]"
        - "&fRegion: &[email protected]"
        - "&fDescription:"
        - "&[email protected]"
        - "&6Click to open."
    discovered:
      material: BOOK
      glowing: true
      displayname: "&[email protected]"
      lore:
        - "&fDiscovered: §[email protected]"
        - "&fDescription:"
        - "&[email protected]"
    notdiscovered:
      material: WRITABLE_BOOK
      glowing: false
      displayname: "&[email protected]"
      lore:
        - "&cNot Discovered"
        - "&fDescription:"
        - "&[email protected]"
  previous:
    material: ARROW
    displayname: "&7Previous page"
    lore: []
  next:
    material: ARROW
    displayname: "&7Next page"
    lore: []
  stats:
    enabled: true
    material: PAPER
    displayname: "&aStatistics"
    lore:
      - "&7Total areas: &[email protected]"


# List of areas and their settings
areas: {}

Areas without descriptions will not work!

Artboard 2.png

  • Unlimited amount of customizable areas.
  • Simple commands with auto-complete & clickable actions.
  • Custom titles and custom messages on the discovery of a new area & when re-entering the discovered area.
  • Custom events for developers (see below).
  • Admin menu for managing areas.
  • User menu.
  • Configurability - custom reward commands, custom reward experience, option to disable menus/titles/messages.
  • Update notifier.

Artboard 2 copy 2.png

1.14+:
WorldEdit - a version that supports 1.14+
WorldGuard - version 7.0.3 or newer
Older than 1.14:
Versions older than 1.14 are no longer supported. Latest snapshot supporting versions from 1.9 to ~1.13 was 1.6.4-SNAPSHOT. Bugs on older versions will not be resolved.

Artboard 2 copy 3.png

To access all admin commands you will need discoverareas.admin permission.

  • /area create <region> <name> - create a new area in certain region
  • /area delete <name> - remove certain area
  • /area setxp <name> - set amount of xp player will get for discovery
  • /area reset [player] - reset yours/player's discovery progress
  • /area setdesc <name> - set area's description
  • /area setsound <name> - set area's discovery sound
  • /area command list <name> - shows all area's reward commands
  • /area command add <name> - add new reward command for area
  • /area command remove <name> - remove reward command
  • /area command edit <cmd_id> <area> - edit reward command
  • /.areas - admin menu

Players have automatically permission to use these commands below, but you can revoke this access by changing node value to false.
Group permission: discoverareas.user

  • /areas - user menu (discoverareas.user.areas node)

To manage commands you need only /area command list <name> because you can manage all commands with clickable actions & messages.

developers api.png
This plugin has several custom events that you can implement into your plugins.

Custom events

PlayerDiscoverEvent - fires when the player discovers a new area
AreaEnterEvent - fires when the player enters an area
AreaLeaveEvent - fires when the player leaves an area

To get DiscoverPlayer instance you can use DiscoverMain.getInstance().getDiscoverPlayer(Player). The player must be online.
Classes DiscoverPlayer and Area are documented, but the main class is not yet.

When you find a bug, please report it on Github page, in discussion or on my discord server (link is below).
Artboard 4.png

Similar projects

Plugin →