Bukkit

This page contains a description of the rbuy version 0.0.0 beta.

Currently all functionality is chat based, with some configuration and permission support using WorldGuard.hasPermission (i assume that would be WEPIF then).

Requirements:

• WorldGuard, tested with 5.3
• WorlEdit, tested with 4.7 - required for WorldGuard anyway.
• admittance, tested with 0.3.5 - this is used to interface to economies, because it was the fastest way for me. Later i might use Register, but i might not. It should be possible to disable admittance and only use it for interfacing rbuy to the economies, though that is a bit of a hack, but still admittance has use, check it out: admittance

Economies:

• Depending on the version of admittance, as with 0.3.5 there would be:
  • Essentials 2.6.1
  • iConomy6
  • iConomy5
  • BOSEConomy 0.7.2
  • MultiCurrency 0.11
  • PluginLibSharedLibrary (not yet available due to taking nights out, for instance.)

Features:

• Selling and buying regions is only possible if the owner/seller is the exclusive owner of the region, the region must not have other owners or members. Ops can sell regions that have no owner, but the op will then be registered as the owner of the rregion.
• Sell a region with /rsell <region> <price> [<currency>]
  Currency is optional and currently only has a real effect for MultiCurrency or plshared, if i am right.
• Remove an offer with /rsell <region>
• List all your offers with /rsell
• Buy a region with /rbuy <region>
• List all regions for sale with /rlist
• List all nearby regions offerd with /rinfo
• Get detailed info about a certain offer with /rinfo <region>
• Reload configuration with rreload
  If you change the datafile use '/rdisable' first, otherwise the data from memory will be written to the datafile before reading the configuratiuon and reloading the data. Then call /renable.
• Disable use with /rdisable
• Enable use with /renable
• enable, disable, reload, rlist, rinfo <region>, (/rinfo would show all infos)

Configuration:

• time-forget-transaction: 21
  This is the time in days for which transactions are stored. Setting to zero should store them forever (NOT RECOMMENDED).
• max-area: 0
  Maximal area that can be bough, cosnidering transaction done in the past time-count-area days.
  Keep it 0, i am not sure this feature works, it failed in one test.
• max-map-height: 127
  Used as upper y-boundary on distance checks.
• show-own: false
  Show your own region offers on /rlist or /rinfo .
• max-offers: 3
  Maximum number of regions you can offer at a time.
• min-map-height: 0
  Lower boundary for distance checks.
• time-count-area: 10
  Time in days for which the area count is done for stored transactions.
• distance-buy: 30
  Distance to the region edges at which players can buy the region.
• max-buy: 5
  Players may only buy this number of regions within the time specified in time-count-buy (days).
• time-count-buy: 10
  Time in days for which stored transactions are counted for the maxBuy boundary.
• users-buy: true
  Non ops can buy, this overrides permissions (!).
• users-sell: true
  Non ops can sell, this overrides permissions (!).
• active: true
  Enable/disable flag - Using these commands will NOT save back the configuration!
• info-radius: 5
  Set this to a reasonable value like 20 (5 is there by a bug)
  Distance to region edges at which the region will be shown as offered on /rinfo.
• distance-sell: 50
  Distance to the region edges at which players can sell the region.
• show-all: true
  Set to false to disable listing all region offers for players.
• Setting values to zero might disable the boundary for most entries. (Keep a value for info-radius set, to limit output.)

Permissions:

• rbuy.buy
• rbuy.sell
• rbuy.reload
• rbuy.enable
• rbuy.disable
• By now all users can use /rinfo, /rlist anyway, ops can use everything. For permissions buy/sell to have effect, you must set usersBuy/usersSell to false in the configuration.

BUGS:

• (critical) Regions from different worlds sharing the same name (region-id) are not processed correctly. It is possible to buy the region of one world, while a region with the same region-id is offered in another world (For some reason the intended check is missing).
  Workaround: set users-buy and users-sell to false and use world-specific permissions to restrict selling and buying to the main world (recommended), or prevent users from choosing their own region names and prevent same region names (ids) occuring in different worlds manually.
• The distance to a region might not be checked correctly on cross world buying (this actually can prevent buying crossworld if regions with same name are more far away than the distance-buy setting specifies, see bug above).
• The default configuration value for info-radius is 5, which means the you have to stand on the ground to get details with /rinfo. Intended was something like 20 for areas with offers of approximate size like 10x10. If you have bigger areas, use some bigger value. The intention of info-radius is to limit the amount of displayed text.
• The area limitations are neither saved nor loaded form the data file (keep the configuration value at zero for max-area, which disables it).

NOTES:

• Logging of transactions is done in the plugins/rbuy/runtime.yml file, they are available for the period specified in the configuration (in days), preset is 21 days.
• Listing nearby regions iterates over all regions by now (due to having failed to use WorldGuards deprecated functionality for that), so this is probably not fit for a large number of regions for sale. To limit this there is configurable limits.
• It is possible to add regions to the datafile, however you should disable rbuy before calling "rreload", bcause rbuy will save data before reloading configuration and data.
• Each manipulation leads to saving the data, so the full transactions and region offers will be written to the file for each change. This might lead to small performance issues if used by many people with many offers/transactions.
• If i am right ops can not bypass the limits for regions for sale yet, but it is possible to preven ordinary users from buying, selling regions by configuration flags, even if you are not using permissions.
• If you use permissions, set the flags usersBuy and usersSell to false, otherwise they will be still able to buy and sell. Info and list commands are always available, ops can do anything (except for bypassing limits) anyway.