DtlTraders: Difference between revisions

From Citizens Wiki

No edit summary
Line 3: Line 3:
| AUTHOR      = dandielo
| AUTHOR      = dandielo
| NAME        = dtlTraders
| NAME        = dtlTraders
| VERSION    = See BukkitDev Page
| VERSION    = 3.0 Beta
| CITIZENSBUILD  = See BukkitDev Page
| CITIZENSBUILD  = See BukkitDev Page
| DEVSTATUS    = Beta
| DEVSTATUS    = Beta
| DEPENDS    =  Citizens 2.0, Vault, and an economy plugin
| DEPENDS    =  Citizens 2.0, Vault, and an economy plugin
| DOWNLOADLINK  = http://dev.bukkit.org/server-mods/dtltraders/
| DOWNLOADLINK  = http://dev.bukkit.org/server-mods/dtltraders/
| DESCRIPTION  = Trader trait for Citizens 2.0. [https://github.com/Dandielo/DtlCitizensTrader/issues Issues page]
| DESCRIPTION  = Trader and Banker trait for Citizens 2.0. [https://github.com/Dandielo/DtlCitizensTrader/issues Issues page]
}}
}}


DtlTraders is a shop and economy plugin for Citizens2
dtlTraders is a shop, item banking and economy plugin for Citizens2.


<div style="border: solid 2px green; background-color: silver; padding:10px; width: 50%;"><p style="font-size: 20px;">Please see  http://dev.bukkit.org/server-mods/dtltraders/ for latest information</p></div>
<div style="border: solid 2px green; background-color: silver; padding:10px; width: 50%;"><p style="font-size: 20px;">Please see  http://dev.bukkit.org/server-mods/dtltraders/ for latest information</p></div>




== Version 3.0 ==
With this version the whole plugin was recoded allowing to change a lot of core things. As because of this this plugin is really small right now but it will grow with time. Already now you got much more support for items like '''Written books''' or '''Custom Potions''', an much more config options.


== Features ==
== Features ==
* Allows to use 3 different trader types, each type has his own features
* Allows to use 1 trader type
* Use price patterns to create pricing tiers for your '''VIP''' ranks
* Displays prices in the traders stock and in a players inventory. So there is nod chat interface needed to see an items price.
* Use item patterns to set prices for damaged items!
* Allows to use 3 different wallet types.
* Displays prices using the new '''Bukkit API''' for item lores and names!
* Compatible with almost each minecraft item
* Use one of 7 wallets that may affect the economy in different ways
 
== Security ==
* Items that don't got a price set, are disabled from buying or selling. But they are still visible to players.
* A lot of security measures to not allow any user getting free items.


== How to install ==
== How to install ==
Line 30: Line 36:


== How to start ==
== How to start ==
Depending of what do you want to achieve, you should choose a trader or banker type first. Each type has his own features, and behaves different in some cases.<br />
Available types are listed below with a short description and basic information what features this types use.


=== Trader types ===
=== Trader types ===
* '''Server trader''' - Is used as a '''Admin shop''', by default this type has an infinite wallet, allowing him to have never ending money! By default any item added to his stock is also infinite, so you can buy as many and sell as many to him. It's also the default created type by the ''/trader create'' command. It's used to allow players sell junk or buy general items. You can set any pattern to him and set any wallet type. You can also limit selling and buying items from/to him.  
* '''Server trader''' - Is used as a '''Admin shop''', by default this type has an infinite wallet, allowing him to have never ending money! By default any item added to his stock is also infinite, so you can buy as many and sell as many to him. It's also the default created type by the ''/trader create'' command. It's used to allow players sell junk or buy general items. You can set any pattern to him and set any wallet type. You can also limit selling and buying items from/to him.  
* '''Market trader''' - It's quite similar to a ''Server trader'' but this type can be only managed through ''patterns''. Pattern for this trader are specific, because of his behavior. You set for him only items he may buy, if a player sell items to him, he will automatically sell them to other players. So no infinite items ;)
 
* '''Player traders''' - This type allows to create shops by regular players, there is no way to duplicate an item, or to bug them with any click combination, and prevents using patterns and infinite wallets.


=== Banker types ===
=== Banker types ===
* '''Money banker''' - This type is not really a fully functional type, it just provides a way to exchange money into items and items into money. So grabbing an ''gold ingot'' from it would grab, lets say 100$ from your account. The item and it's value can be changed in the ''config''.
No types available right now
* '''Private banker''' - This type provides a ''item banking'' feature, allowing players to stock items to it. Each account may have up to 9 tabs, and each tab may have 45 items in it, and this makes a quite big stockroom. Its still early beta, so many things are static and can't be changed.
* '''Guild banker''' - For now it's just a project, but when it's going to be done, it will allow to stock items and share them to players from the same ''faction'', ''clan'' or ''town''. Maybe with a feature to assign ranks or players for tabs.
 
<!--
 
<br />
=== Locale support ===
Almost any message displayed by this plugin can be very easily modified.
 
DtlTraders is available in english only at this moment.
 
If you are willing to help translate this plugin to a different languange please contact the author.
<br />
 
== Installation ==
 
==== Dependencies ====
#Citizens 2.0 or 2.0.1
#Vault
#economy plugin (vault compatible)
<br />
 
==== Installation steps ====
# Download the latest build at: http://dev.bukkit.org/server-mods/dtltraders/
# Put the '''dtlTrader.jar''' file in the plugins directory
<br />
The plugin will generate default configuration files when it is run for the first time.
<br />
==== Configuration ====
All configuration nodes can be found here http://wiki.citizensnpcs.com/DtlTraders/config
<br />
== How to start ==
=== Creating a trader ===
To create a trader you can add a trait to an existing npc by using the following command:
<br />
'''/trait trader'''
<br />
be sure to respawn the npc for the changes to take effect.
<br />
<br />
There are two ways you can accomplish the above when creating a completely new character. The first one is to use:
<br />
'''/npc create ''trader name'' -- trait trader'''
<br />
<br />
The second way is taking advantage of the '''trader''' command. It has 3 optional arguments that control the type, wallet (for traders) and entity type. Arguments can be supplied in any order.
<br />
'''/trader create ''trader name'' [t:<trader-type>] [w:<wallet-type>] [e:<entity-type>]'''
<br />
if you don't supply any arguments the plugin will default to a server trader type with infinite wallet.
<br />
=== Creating a banker ===
Bankers can only be created by using the '''/trader''' command.
'''/trader create ''Name'' t:money-bank'''
or
'''/trader create ''Name'' t:player-bank'''
<br />
=== Commands ===
A complete list of available commands and their description can be found [http://wiki.citizensnpcs.com/DtlTraders/Commands here].
<br />
=== Permissions ===
A complete list of permission nodes and their description can be found [http://wiki.citizensnpcs.com/DtlTraders/permissions here].
<br />
=== Types ===
A list of supported trader types can be found [https://github.com/Dandielo/DtlCitizensTrader/wiki/Trader-Types here].
<br />
 
==== Server Trader Tutorial - by Inexion (THANKS :D) ====
{{#ev:youtube|PHQZE94GG88|420}}
 
== More information ==
The wiki pages are currently beeing updated, any missing information should show up in the coming days. If you have any questions or ideas to implement you can usually find me on the '''[http://esper.net/publicirc.php esper.net IRC]''' channel [irc://irc.esper.net/dtlTraders #dtlTraders]. You can also e-mail me at [email protected] .
<br />


== Version 2.0RC 0.77 (fixed some bugs from 0.74 and 0.76) ==
A lot of updates was added to this version, so be prepared for a refreshing wind ;> You can download this version [https://github.com/downloads/Dandielo/DtlCitizensTrader/dtlTrader-2.0RCv0.77.jar here]
# Added a new trader type, it's total base on patterns, you need to set him what he will buy from the user and you need to set the prices for how many he will sell that stuff.
# refreshed patterns and added more functions to them, now you can create "tiers" in the "prices" section, allowing you to set prices for different "permission groups"! To allow a player use a "tier" you need to add him a simple perm, like: "dtl.trader.tiers.tier1".
# also added "multipliers" for price patterns, base is 1.0, so you can easily change all prices by an "multiplier" ;)
# fixed many bugs: crashing without denizen plugin, permission bugs, pattern issues, some messaging issues, and a lot of other smaller things...
# added also "Lores" and special Names for "managing items"! Now you won't see "lime wool" but "Buy stock!"
# Displayign prices in the items description!
# changed the pricing system, from up now prices are calculated for each player separately, so tiering is available!
# removed spawning of ender pearls when moving xd
# more changes soon! :D-->


== Navigation ==
== Navigation ==

Revision as of 02:33, 27 May 2013

File:DltTraders.png

dtlTraders


Author dandielo
Version 3.0 Beta
Citizens build See BukkitDev Page
Other dependencies Citizens 2.0, Vault, and an economy plugin
Download Link
Description: Trader and Banker trait for Citizens 2.0. Issues page

dtlTraders is a shop, item banking and economy plugin for Citizens2.

Please see http://dev.bukkit.org/server-mods/dtltraders/ for latest information


Version 3.0

With this version the whole plugin was recoded allowing to change a lot of core things. As because of this this plugin is really small right now but it will grow with time. Already now you got much more support for items like Written books or Custom Potions, an much more config options.

Features

  • Allows to use 1 trader type
  • Displays prices in the traders stock and in a players inventory. So there is nod chat interface needed to see an items price.
  • Allows to use 3 different wallet types.
  • Compatible with almost each minecraft item

Security

  • Items that don't got a price set, are disabled from buying or selling. But they are still visible to players.
  • A lot of security measures to not allow any user getting free items.

How to install

To install it you need basically three plugins: Citizens 2, Vault any Economy plugin supported by Vault. It's also recommended to use a Permission plugin. Always try to have latest version of these plugins.
After you gathered all of them you can start using dtlTraders.

All default permissions to manage a trader should be added by default when you are Op.

How to start

Trader types

  • Server trader - Is used as a Admin shop, by default this type has an infinite wallet, allowing him to have never ending money! By default any item added to his stock is also infinite, so you can buy as many and sell as many to him. It's also the default created type by the /trader create command. It's used to allow players sell junk or buy general items. You can set any pattern to him and set any wallet type. You can also limit selling and buying items from/to him.


Banker types

No types available right now


Navigation

DtlTraders
Configuration Commands | Permissions | Locale
Usage Patterns
Types
Denizen Support Commands