EconomyWarp

Bukkit Plugins
1.2k Downloads

EconomyWarp - 0.1.1

Features

Highly customizable teleportation commands, implementing an economy backend.

  • To really understand all that this plugin can do, read through the permissions nodes.
  • Flexible multiworld support. (requires Multiverse-Core)
  • Create, rename, reset, and delete an unlimited number of warps.
  • Individual pricing options for all warp functions.
  • Home feature allows users to set a home location.
  • Spawn feature allows users to return to spawn.
  • Random teleportation - customizable distance, cooldown, and starting point (player or spawn).
  • Top and Up commands allow players or admins to quickly go up to higher locations.
  • Back command to teleport you to the last place you were teleported from.
  • Admins can make warps that everyone can see.

NOTICES

  • I will not respond to private messages. Leave a comment or put something in the issue tracker.
  • If there is a bug in this plugin, PLEASE make note of it in the issue tracker, and I will attempt to address it as I get time.
  • I wrote this plugin for myself, because I wanted to - I'm not terribly concerned about adding features that I don't need to it.
  • This plugin was highly inspired by EcoWarp. However, EcoWarp kept warping my players into walls, through floors, losing mounts, etc. This frustrated me into making something more configurable that worked better.

Commands

  • /warp - basic functionality of warping.
  • /spawn - returns a player to the Multiverse defined spawn location of the respawnWorld for the player's current world.
  • /home - returns a player to the location they have set as home for the current world group.
  • /top - moves a player to the top block above them if it is "safe."
  • /up - moves the player up to the next "safe" area above them which is large enough to accommodate them.
  • /random - moves the player to a completely random location within limits set in the config.
  • /back - returns the player to the last place they teleported from (includes death location).

Demo

Short demo, sorry there's no audio, I hacked this together real fast with Evolve.

Aliases

  • warp: ewarp, ew
  • spawn: ews, ewspawn
  • home: h, ewh, ewhome
  • up: u, eu, ewup
  • top: t, ewt, ewtop
  • random: rand, ewrand, ewrandom
  • back: b, ewb, ewback

Requirements

  • Vault
  • Multiverse-Core
  • SQLibrary NOTE: Currently, this plugin *REQUIRES* a MySQL backend. I wrote this for myself, and so it has only the features I wanted to use.

Permissions

permissions:
  economywarp.*:
    description: Full access (not recommended)
    children:
      economywarp.help: true
      economywarp.warp.list: true
      economywarp.warp.list.other: true
      economywarp.warp.list.all: true
      economywarp.warp: true
      economywarp.warp.toother: true
      economywarp.warp.costexempt: true
      economywarp.warp.other: true
      economywarp.warp.other.toother: true
      economywarp.warp.other.costexempt: true
      economywarp.warp.all: true
      economywarp.warp.all.other: true
      economywarp.warp.create: true
      economywarp.warp.create.other: true
      economywarp.warp.create.all: true
      economywarp.warp.create.costexempt: true
      economywarp.warp.rename: true
      economywarp.warp.rename.other: true
      economywarp.warp.rename.all: true
      economywarp.warp.rename.costexempt: true
      economywarp.warp.set: true
      economywarp.warp.set.other: true
      economywarp.warp.set.all: true
      economywarp.warp.set.costexempt: true
      economywarp.warp.info: true
      economywarp.warp.info.other: true
      economywarp.warp.remove: true
      economywarp.warp.remove.other: true
      economywarp.warp.remove.all: true
      economywarp.warp.remove.costexempt: true
      economywarp.warp.share: true
      economywarp.warp.share.costexempt: true
      economywarp.spawn: true
      economywarp.spawn.other: true
      economywarp.spawn.all: true
      economywarp.home: true
      economywarp.up: true
      economywarp.top: true
      economywarp.back: true
      economywarp.random: true
      economywarp.admin.setdb: true
      economywarp.mod.help: true
      economywarp.admin.reload: true
      economywarp.admin.help: true
  economywarp.player.*:
    description: Gives access to general player features.
    children:
      economywarp.help: true
      economywarp.warp.list: true
      economywarp.warp.list.all: true
      economywarp.warp: true
      economywarp.warp.create: true
      economywarp.warp.rename: true
      economywarp.warp.set: true
      economywarp.warp.info: true
      economywarp.warp.remove: true
      economywarp.warp.share: true
      economywarp.spawn: true
      economywarp.home: true
      economywarp.up: true
      economywarp.top: true
      economywarp.back: true
      economywarp.random: true
  economywarp.mod.*:
    description: Gives access to general moderator features.
    children:
      economywarp.help: true
      economywarp.warp.list: true
      economywarp.warp.list.all: true
      economywarp.warp: true
      economywarp.warp.create: true
      economywarp.warp.rename: true
      economywarp.warp.set: true
      economywarp.warp.info: true
      economywarp.warp.remove: true
      economywarp.warp.share: true
      economywarp.spawn: true
      economywarp.home: true
      economywarp.up: true
      economywarp.top: true
      economywarp.back: true
      economywarp.random: true
      economywarp.warp.list.other: true
      economywarp.warp.toother: true
      economywarp.warp.other: true
      economywarp.warp.create.other: true
      economywarp.warp.rename.other: true
      economywarp.warp.set.other: true
      economywarp.warp.info: true
      economywarp.warp.info.other: true
      economywarp.warp.remove.other: true
      economywarp.spawn.other: true
      economywarp.mod.help: true   
  economywarp.help:
    description: Lists command options.
    default: true
  economywarp.warp.list:
    description: Lists your warps.
    default: true
  economywarp.warp.list.other:
    description: Lists <player>'s warps.
    default: op
  economywarp.warp.list.all:
    description: Lists all warps.
    default: true
  economywarp.warp:
    description: Warps you to <warp>.
    default: true
  economywarp.warp.costexempt:
    description: Prevents you from paying the cost of warping yourself.
    default: op
  economywarp.warp.toother:
    description: Allows you to warp to other player's warps.
    default: op
  economywarp.warp.other:
    description: Warps <player> to <target-player>'s <warp>.
    default: op
  economywarp.warp.other.toother:
    description: Allows you to warp other people to other people's warps.
    default: op
  economywarp.warp.other.costexempt:
    description: Prevents you from paying the cost of warping others.
    default: op
  economywarp.warp.all:
    description: Warps everyone to <warp>.
    default: op
  economywarp.warp.all.other:
    description: Warps everyone to <target-player>'s <warp>.
    default: op
  economywarp.warp.create:
    description: Creates a warp with <name>.
    default: true
  economywarp.warp.create.other:
    description: Creates a warp for <target-player> with <name>.
    default: op
  economywarp.warp.create.all:
    description: Creates a warp for everyone with <name>.
    default: op
  economywarp.warp.create.costexempt:
    description: Prevents you from paying the cost of creating new warps.
    default: op
  economywarp.warp.rename:
    description: Renames <warp> to <new-name>.
    default: true
  economywarp.warp.rename.other:
    description: Renames <target-player>'s <warp> to <new-name>.
    default: op
  economywarp.warp.rename.all:
    description: Renames everyone's <warp> to <new-name>.
    default: false
  economywarp.warp.rename.costexempt:
    description: Prevents you from paying the cost to rename a warp.
    default: op
  economywarp.warp.set:
    description: Moves <warp> to new location.
    default: true
  economywarp.warp.set.other:
    description: Moves <target-player>'s <warp> to new location.
    default: op
  economywarp.warp.set.all:
    description: Moves everyone's <warp> to new location.
    default: op
  economywarp.warp.set.costexempt:
    description: Prevents you from paying the cost to change a warp location.
    default: op
  economywarp.warp.info:
    description: Gives info about <warp>.
    default: true
  economywarp.warp.info.other:
    description: Gives info about <target-player>'s <warp>.
    default: op
  economywarp.warp.remove:
    description: Removes <warp>.
    default: true
  economywarp.warp.remove.other:
    description: Removes <target-player>'s <warp>.
    default: op
  economywarp.warp.remove.all:
    description: Removes everyone's <warp>.
    default: op
  economywarp.warp.remove.costexempt:
    description: Prevents you from paying the cost to remove a warp location.
    default: op
  economywarp.warp.share:
    description: Allows you to share a warp with another player.
    default: true
  economywarp.warp.share.costexempt:
    description: Prevents you from paying the cost to share a warp.
    default: op
  economywarp.spawn:
    description: Gives access to the /spawn command.
    default: true
  economywarp.spawn.other:
    description: Allows you to /spawn <player>.
    default: op
  economywarp.spawn.all:
    description: Allows you to send all players to spawn.
    default: op
  economywarp.home:
    description: Allows you to create and warp to a home location.
    default: true
  economywarp.up:
    description: Allows you to very easily move /up to the next open space above you.
    default: true
  economywarp.top:
    description: Allows you to very easily move to the top block above you if it is solid and safe.
    default: true
  economywarp.back:
    description: Allows you to use /back to return to the last location you warped from.
    default: true
  economywarp.random:
    description: Allows you to use the /random command.
    default: true
  economywarp.mod.help:
    description: Displays help for the moderator commands.
    default: op
  economywarp.admin.reload:
    description: Reloads the config.
    default: op
  economywarp.admin.setdb:
    description: Allows you to /warp setdb <host> <user> <pass> <name> <table>.
    default: op
  economywarp.admin.fixdb:
    description: Allows you to fix the database entries after an update.
    default: op
  economywarp.admin.help:
    description: Displays help for the admin commands.
    default: op

Config

# MySQL database connection is absolutely required at this time.
database:
  host:
  port: 3306
  name:
  user:
  pass:
  prefix: EconomyWarp_

settings:
  # Globally enable or disable sharing of warps (/warp share <player> <name>)
  allowSharing: true
  # The cost to warp to a location (/warp <name>)
  warpCost: 2
  # This is in here for completion, but currently doesn't function correctly.
  warpOtherCost: 5
  # The cost to create a warp (/warp create <name>)
  createCost: 10
  # The cost to rename a warp (/warp rename <old-name> <new-name>)
  renameCost: 1
  # The cost to move a warp to a new location (/warp set <name>)
  setCost: 2
  # The cost to remove a warp (/warp remove <name>), can be negative to refund cost.
  removeCost: -1
  # The cost to share a warp with another player (/warp share <player> <name>)
  shareCost: 5
  # The cost to use the home command (/home)
  homeCost: 0
  # Whether or not to use specific world groups. If enabled, warps will only be accessible for the world group a player is in.
  useGroups: false
  # Time between random warps (/random) in minutes.
  randomCooldown: 30
  # The minimum distance (x, z) to travel.
  randomMinDistance: 100
  # The maximum distance (x, z) to travel.
  randomMaxDistance: 1000
  # This will be random from the world's Multivers respawnWorld specified spawn location if false.
  randomFromPlayer: true
  
worldGroups:
# groupName:
# - world1
# - world2

Known Issues

  • There is no cost configuration for /spawn, /random, /up, or /top.
  • warpOtherCost in the configuration doesn't do anything.
  • MySQL is a requirement.
  • If a chunk is unloaded, under extreme lag, every once in a while a horse or pig will be lost.
    • If this occurs, it is remedied by logging out and back in without moving.
  • There is no configuration to set different costs for different world groups (for scaling to economies in different environments).
  • There is no way to limit the maximum number of warps a player can create.