Below is information to learn about setting up individual regions for use with AreaShop. If you are planning to use a lot of regions with AreaShop then read the Advanced regions setup page, which might help you setting up your regions a lot faster.
Rental region
First create the region where you want the players to rent it, you do this with WorldGuard.
Select a region with the wooden axe and then type: /region define <name>, where <name> is
replaced by the name you want the region to have. Now you have two options:
- Add the region without a sign by using the command
/as add rent [region]. If you specify the region then only that one will be added to AreaShop, if you don't specify it then all regions intersecting with your WorldEdit selection will be added (you are still able to link sign(s) to these regions later). - Add the region by placing a sign (the sign can then be used by players to rent it). If you choose this option then check the details below.
| Line # | Content | Explanation |
|---|---|---|
| Line1 | [asrent] |
Static text to identify this as a renting sign (can be changed in the config) |
| Line2 | regionname or empty | Optional: The name of the region to link the sign to, defaults to the region the sign is placed in |
| Line3 | duration or empty | Optional: The rental duration as: number[space]identifier, examples: 1 day, 2 weeks, 3 years. All usual English time indicator words can be used (singular and plural) and you can add more in config.yml. Defaults to the duration in default.yml |
| Line4 | money or empty | Optional: Amount of money they need to pay for one duration, defaults to the price specified in default.yml |
Left: Sign as you type it in Minecraft
Middle: Sign when succesfully registered and ready to use
Right: Sign if a user rented the region
The sign will be changed to the specification in the config if placed correctly, every line of the sign can be formatted. Also the right/left click actions can be changed with distinction between sneaking/non-sneaking. A configurable list of commands will be executed when one of these events happen.
Using rent region signs
If you want to rent a region, simply rightclick the sign and you have it. If you can't rent the region AreaShop will indicate why (no permission, no money, etc.).
If you want to rent the region longer, or you want to extend it just right click the sign again and the region will be rented for another duration.
You can left click a sign to check all information about the region.
If your rental ends the region will become available again, at which point the sign will show the [ForRent] information again. By using the AreaShop commands you can also extend or stop your
rent from anywhere in the server. If you cancel your rent halfway your renting
period you will get a refund for the unused part. If you sneak-rightclick the sign while the region is rented you will unrent the region.
Buy regions
First create the region where you want the players to rent it, you do this with WorldGuard.
Select a region with the wooden axe and then type: /region define <name>, where <name> is
replaced by the name you want the region to have. Now you have two options:
- Add the region without a sign by using the command
/as add buy [region]. If you specify the region then only that one will be added to AreaShop, if you don't specify it then all regions intersecting with your WorldEdit selection will be added. - Add the region by placing a sign (the sign can then be used by players to buy it). If you choose this option then check the details below.
| Line # | Content | Explanation |
|---|---|---|
| Line1 | [asbuy] |
Static text to identify this as a buying sign (can be changed in the config) |
| Line2 | regionname or empty | Optional: The region to link to this sign, defaults to the region the sign is placed in |
| Line3 | money or empty | Optional: Amount of money they need to pay to buy this region |
| Line4 | - | This line does not need to contain anything and is ignored |
Left: Sign as you type it in Minecraft
Middle: Sign when succesfully registered and ready to use
Right: Sign if a user bought the region
Using buy region signs
The following section assumes a default config. If you want to buy a region, simply rightclick the sign. If you cannot buy the region AreaShop will indicate why (no permission, no money, etc.) You can leftclick a sign to check all information about the region. By using the AreaShop commands you can stop your buy from anywhere in the server. If you sneak-rightclick the sign while the region is rented you will sell the region.
Adding extra signs to existing regions
There are three ways to add signs to already existing regions:
- Place a sign somewhere, look at the sign and then execute the command
/as addsign [region]. If you don't specify a region the plugin will try to detect inside which region the sign is and use that one. - Use the
/as linksignscommand, and then use left click while pointing towards a sign to select a sign, and use right click while pointing towards a region to select a region. Once both a region and a sign have been selected the sign will be added to the region, and then you can click again for the next one. Use the same command again to exit the sign linking mode. - Place a new sign somewhere with the lines specified below:
| Line # | Content | Explanation |
|---|---|---|
| Line1 | [as] |
Static text to identify this as a AreaShop sign (can be changed in the config) |
| Line2 | regionname or empty | Optional: The region that the sign should be linked to, defaults to the region the sign is placed in |
| Line3 | sign profile or empty | Optional: The profile to use for the sign (check 'signProfiles' in config.yml) |
| Line4 | - | This line does not need to contain anything and is ignored |
Usage and configuration:
- Commands and Permissions
- Basic regions setup
- Advanced regions setup
- Configuration files
- Download (releases)
Advanced features:
- Save/restore region blocks
- Change the language
- Limitgroups (setup how many regions players can rent/buy)
Troubleshooting:
Development:
Connections:
