Skip to content

Latest commit

 

History

History
77 lines (69 loc) · 7.5 KB

README.md

File metadata and controls

77 lines (69 loc) · 7.5 KB

AreaShop logo

Usage and configuration: ►Download (releases)   ►Commands and Permissions
         ►Basic regions setup   ►Advanced regions setup   ►Configuration files
Advanced features: ►Save/restore region blocks   ►Change the language   ►Limitgroups
Troubleshooting: ►Frequently Asked Questions   ►Common errors
Support: ►Request a feature, report a bug or ask support   ►Open issues
Development: ►Compiling   ►Modules/classes overview ►Javadocs ►Development builds
Connections: ►AreaShop in Spigot Resources   ►AreaShop on BukkitDev

Required dependencies

  • Java 17 or higher (latest recommended)
  • Bukkit/Spigot 1.17.2 or newer (hybrids such as Mohist are not supported)
  • WorldGuard: 7.0.7 or newer
  • WorldEdit: 7.2.12 or newer
  • Vault: 1.7.3 or higher
  • An economy plugin supported by Vault (check the Vault page for a list of these)

Optional Dependencies

  • FastAsyncWorldEdit 2.4.5 or newer (Note: Use either FAWE or WE, not both together)
    • AreaShop has a separate adapter for FAWE which leverages its support for asynchronous edit operations. This adapter is used for region saving and restoring.
    • Note that schematics created by the FAWE adapter are not compatible with normal WorldEdit; however, schematics created by the normal WorldEdit adapter are compatible with FAWE
    • Due to a bug with FAWE, entities are not saved by the FAWE adapter but are saved in the normal WE adapter

AreaShop allows you selling and renting regions to players. It could be used to let them rent a jail in your prison server, a shop in the market of the survival server or a plot on a creative server. The player interacts with signs, making it easy to use. It also has a lot of commands to check the status of all regions, manage the renting and buying of a region and also features for admins. A lot of messages send to the player can be clicked, for immediately performing actions (buying the region, selling the region, etc.) or getting more information (for example clicking region name for region information). To setup the renting and selling of the regions exactly as you want AreaShop has a lot of options to custimize it to your liking.

All features in a list

  • Rent and sell regions to players, and players can resell their bought regions to other players.
  • Signs for easy interaction (rent/buy/unrent/sell/information) and current status (layout and actions customizable, multiple signs can be added).
  • rented-sign
  • Messages that can be clicked for more information and actions (language can be changed, as well as click/hover actions).
  • region-information-message
  • Change the of the plugin or use of the already provided language files (check here)
  • Automatically restore the region to its original state when sold: restore the region with schematics.
  • Change which commands players can use with permissions.
  • Customize the plugin by changing the config files.
  • Use any WorldGuard flags on regions: disable building in the region, deny entry to others, etc.
  • Teleport to regions (while making sure the location is safe for the player) and changing the teleport location.
  • Adding friends to regions (which also can teleport to it).
  • Automatic unrent/sell for regions of which the owner is offline for a certain time.
  • Warning to players when their rent is about to run out (at login and while they are online).
  • Group system to set options for a couple of regions instead of all of them (all settings in default.yml can also be used for groups and individual regions).
  • High performance: All heavy tasks are spread over time (each tick a part is executed until done), so the plugin should not cause any lag.
  • Limit number of regions a player can have: limits can be different per permission node (player group), world or group of regions (possible situation: Normal players can buy 1 market region in survival + 1 build region in survival and 2 plots in creative, while VIPs have double limits for all those), check these examples.
  • Supports name changes because of saving player info by UUID (more details).

Preview

For a preview join 'mc.go-craft.com' and go to the Survival server, the shops around the spawn use AreaShop.

Tutorial & Feature overview (AreaShop V2.0.1)

Made by Koz4Christ
Tutorial Video

Prison cell setup tutorial (AreaShop V2.1.0)

Made by PerkulatorTime
Tutorial Video

Old video for AreaShop v1.0: Tutorial by VariationVault