Configuration and setting up
Configuration and Setting Up
Setting up stores and chests
(There's a video tutorial on the main page.)
First of all, you need to build an enclosed area, like a house without doors. It is very important that the only way in and out is by teleporting, otherwise players will be able to simply walk out without paying. Unless your are playing on a private server with only your friends, you need to have some kind of protection plugin, so the players don't make holes in the walls.
Then stand on the spot from which you will be able to teloport into the store and type /rsset entrance. The location is stored in a variable. Now get to the spot from which you will teleport out of the store and type /rsset exit. This location is stored in another variable. Now you can type /rsset createstore and the name of the store, and it is created. You can set several entrances/exits to a store by creating multiple stores with the same name. They will act like one store. I recommend that you make the wall between the entrances and exits of either glass panes or glass blocks. Users can then simply right-click the glass instead of typing /rsenter or /rsexit.
From version 0.43 you can choose to have doors as entrances if enable-doors-as-entrances is true. In that case the door should be placed on either an entrance or an exit spot for it to be recognized. Test if everything works, and if the door can't be opened.
This image shows a couple of the most simple entrance/exit set-ups (click for larger resolution):
You can set the prices for different items using /rssetprices add id:price. Put a large supply of the items in chests around the store OR create a self-refilling chest.
If you need help with setting prices, maybe this project will help you. From version 0.43 you can import prices from Minecraft Economy Manager using the /rsimport command. If you wish to do this, see the Import Prices page.
Self-refilling chests
To create an awesome self-refilling chest first place a block where you want it to be. Then stand on top of the block and type "/rssetchests create". When the chest is created you only get a message, the block won't turn into a chest. Yet.. Now add items to the chest by typing "/rssetchests additems " and the id(s) of one or more items, separated by commas. Example "/rssetchests additems 5,9,11". When somebody enters the store the block turns into a chest, filled with full stacks of the items you set.
To create a "cash-register", so the players don't need to use /rspay and /rscost, put a SLAB (ID 44) on top of a block of OBSIDIAN. It doesn't matter what kind of SLAB it is. To use the "cash-register" right- or left-click the obsidian block, not the slab.
Configuration
All settings are stored in realshopping.properties. You can edit the file if you want, but if you don't understand something then let it be, and it will probably turn out to the best. There are automaticly generated comments in the config which I hope will make it easier to understand.
language-pack
First of all, language-pack specifies which language-pack located in RealShopping/langpacks/ the mod should use. A default english is loaded when the langpack isn't found.
I have made a Swedish language pack which is available at GitHub. The default embedded one is also there.
enable-automatic-updates
If you want the mod to check for updates and/or update itself you need to configure enable-automatic-updates. If it's set to false (default) there will be no update checks whatsoever. The update checks occur when the server is loading, so it will load slightly faster if this is false.
If you want the mod to only look for updates, but not be able to update, set it to check or check-console. You can then get the newest version's description by /rsupdate info. the -console part means that you can only do it from the console, otherwise OPs and players with realshopping.rsupdate permission can use the command.
If you want the mod to look for updates, and be able to update, set it to ask or ask-console. You can then get the newest version's description by /rsupdate info and update by /rsupdate update. the -console part means that you can only do it from the console, otherwise OPs and players with realshopping.rsupdate permission can use the command.
If you feel like you don't need any control at all, set it to true and the mod will find and download a new version for you automatically. The progress will be shown in the console.
punishment & jail-location & hell-location & drop-items-at
punishment can be either hell, jail, or none. If hell, then players who try to steal from the store are teleported to hell-location while all their items are moved to drop-items-at. You can make an obstacle course between those two points, or just leave hell-location to world,0,0,0 and let the thieves die in the void instead.
If jail is chosen, the thief is teleported to jail-location and jailed, which means he can't interact with the world. The player is jailed until someone unjails him.
If none is chosen the mod will try to prevent the player from teleporting out of the store.
player-stores-create-cost
player-stores-create-cost - This is the cost of creating a player-owned store. If you don't want players to create billions of stores ;)
Store management AI
enable-automatic-store-management - true if the server allows stores to monitor statistics from itself and other stores, and also if the stores may automatically change prices. All AI features need to be improved so I don't recommend enabling this on big servers.
statistics-timespan - how far back in time the AI looks for statistics. On servers where things happen fast, use a shorter timespan. On "slow" servers, a larger one. You can use 'hour', 'day', 'week', 'month', or a number of seconds. Default is 'week'
stat-updater-frequency - how often the statistics thread should be ran. This is also the time it takes from the last server startup (or reload) till it correctly checks if the statistics have changed. You should use a value close to statistics-timespan if you're not reloading your server often, but a lower one otherwise. You can use 'hour', 'day', 'week', 'month', or a number of seconds (minimum 60 sec). Default is 'hour'
clean-stats-older-than - how old statistics can be before they are removed from the database. Can be 'hour', 'day', 'week', 'month', or a number of seconds, but needs to be larger than statistics-timespan and stat-updater-frequency. Default is 'month'
enable-shopping-carts-in-worlds
enable-shopping-carts-in-worlds - here you write a list of all worlds supporting shopping carts, separated by commas. You can write @all to enable carts in all worlds.
Notifications
notificatior-update-frequency (this is misspelled, I will fix this in 0.50) - in milliseconds how often the notifications thread should be ran. Anything bellow 500 disables notifications. 10000 is default and should be good.
delivery-cost-zones
delivery-cost-zones - This is the number of "delivery zones" you want to set. A delivery zone means that you need to pay an extra fee for receiving a sent package, if it is sent far enough.
You declare each zone with zone N:SIZE:COST where N is the number of the zone, SIZE how far the package must be sent to be in that zone (number of blocks OR world for multi-world zones), and COST is the extra fee. The fee can also be in percent, simply by adding a percent sign after it. The zones declarations must be after delivery-cost-zones. Example:
-
-
delivery-cost-zones:4
zone 1:100:5 If the package must travel 100 blocks or more there is a 5 dollar fee.
zone 2:500:15 If the package must travel 500 blocks or more there is a 15 dollar fee.
zone 3:1000:25 If the package must travel 1000 blocks or more there is a 25 dollar fee.
zone 4:world:100% If the package must travel to another world you pay 100% of the buying price when receiving the package.
-
-
A couple of enable/disable functions
enable-selling-to-stores - true if you want players to be able to sell items to the stores. False otherwise.
auto-protect-chests - true if you want self-refilling to be "protected" automatically. Just leave it as false if you're ignoring this function.
keep-stolen-items-after-punish can be either true or false. If true, thieves keep the stolen items after they've been punished, which I don't recommend if you sell a lot of stuff in the store. If false, their inventory is first restored to what they had when they entered the store.
allow-filling-chests - true if users are allowed to use commands that fill chests. Set this to false if you have some kind of chest protection plugin. Also disables shopping carts and shipping.
enable-doors-as-entrances - true if stores should be allowed to use doors instead of glass blocks/panes as entrances. Doors that are on entrances or exits will not be possible to open, neither by right-clicking nor redstone, while RealShopping is running.new!
disable-item-drop, disable-crafting, disable-buckets, disable-ender-chests - true if dropping items, crafting, using buckets and Ender Chests inside stores should be disabled. Use this to avoid abuse, or use World Guard instead.
Comments