Upstream/AreaShop
1
0
Fork 0
mirror of https://github.com/NLthijs48/AreaShop.git synced 2024-11-29 05:35:12 +01:00
Code Issues Projects Releases Wiki Activity

Shorter and updated text

Thijs Wiefferink 2017-01-13 19:04:39 +01:00
parent 14c613d691
commit bc490ddc14
1 changed files with 25 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
Basic-regions-setup.md

@ -1,19 +1,19 @@
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](https://github.com/NLthijs48/AreaShop/wiki/Advanced-regions-setup) page, which might help you setting up your regions a lot faster.
## Rent signs
## 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:
1. 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 intersection with your WorldEdit selection will be added (you are still able to link sign(s) to this region later).
1. 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).
2. 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 empt | The name of the region the players can rent here, can be left empty if the sign is inside the region, then the plugin will find the name
Line3 | timeformat or empty | Optional: The length of renting this region, number[space]identifier, `1 day` for example, check possible identifiers in the table below (identifiers can be changed in the config)
Line4 | money or empty | Optional: Amount of money they need to pay for 1 length of the timeformat (use a dot and not a comma if you want decimals)
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
@ -23,47 +23,30 @@ Line4 | money or empty | Optional: Amount of money they need to pay for 1 length
![Rent sign placement](https://cloud.githubusercontent.com/assets/6951068/10560927/a4d0dd0a-7519-11e5-8b57-92ad7dd5b239.png)
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. The money is without the currency (so just the number), the part before and after the number can be configured in the config (with Euro symbol support).
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.
Do you not get a confirmation message with an `[AreaShop]` prefix but a message without that prefix instead? Then you probably have a conflicting plugin that tries to detect the same first line on the sign (for example the Essentials buy signs). No worries though, just open the `config.yml` file in the AreaShop folder and change the tags in the `signTags` section to something else that is not used by other plugins. After you did that make sure you use `/as reload` or restart your server.
Check the table below for all the possible identifiers for the timeformat (these are the default identifiers, can be changed in the config).
Unit | Possible identifiers
-----|---------------------
Seconds | s, sec, secs, second, seconds
Minutes | m, min, mins, minute, minutes
Hours | h, hour, hours
Days | d, day, days
Weeks | w, week, weeks
Months | M, month, months
Years | y, year, years
#### Using rent signs
The following section assumes a default config.
If you want to rent a region, simply rightclick the sign and you have it. The plugin
gives you a message if you can't rent the region (no permission, no money, etc.)
If you want to rent the region longer, or you want to extend it just rightclick again and the sign will update the expiration date/time.
You can leftclick a sign to check all information about the region.
At the end of your rent the sign will change to ForRent again and someone else can
come by and rent it. By using the build in commands you can also extend or stop your
rent from anywhere in the same server. If you cancel your rent halfway your renting
#### 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 signs
## 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:
1. 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 intersection with your WorldEdit selection will be added.
1. 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.
2. 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 | The name of the region the players can buy here, can be left empty if the sign is inside the region, then the plugin will find the name
Line3 | money or empty | Optional: Amount of money they need to pay for 1 length of the timeformat (use a dot and not a comma if you want decimals)
Line4 | - | This line does not need to contain anything
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
@ -73,24 +56,23 @@ Line4 | - | This line does not need to contain anything
![Buy sign placement](https://cloud.githubusercontent.com/assets/6951068/10560926/a4be419a-7519-11e5-8a22-adb166bd9fb1.png)
#### Using sell signs
#### Using buy region signs
The following section assumes a default config.
If you want to buy a region, simply rightclick the sign and you have it. The plugin
gives you a message if you can't buy the region (no permission, no money, etc.)
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 build-in commands you can stop your
buy from anywhere in the same server. If you sneak-rightclick the sign while the region is rented you will sell 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:
1. First place a sign somewhere, then look at the sign from less then 100 blocks away and then execute the command `/as addsign [region] [profile]`. If you don't specify a region the plugin will try to detect inside which region the sign is and use that one. If you don't specify a profile then `default` will be used (check `signProfiles` in `config.yml`) otherwise the specified profile will be set for just this sign.
2. Use the `/as linksigns` command, and then use leftclick while pointing towards a sign to select a sign, and use rightclick 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.
1. 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.
2. Use the `/as linksigns` command, 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.
3. 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 | The name of the region where the sign should connect to, can be left empty if the sign is inside the region, then the plugin will find the name
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
Line4 | - | This line does not need to contain anything and is ignored