DtlTraders: Difference between revisions

From Citizens Wiki

No edit summary
Line 11: Line 11:
}}
}}


<div style="border: solid 2px red; background-color: silver; padding:10px; width: 50%;"><p style="font-size: 20px;">This page will change during the whole "Beta" phase, so be aware of any changes!</p></div>
<div style="border: solid 2px red; background-color: silver; padding:10px; width: 50%;"><p style="font-size: 20px;">This page will change rapidly during the whole "Beta" phase, keep in mind that the plugin version you are running may quickly become outdated!</p></div>


This plugin was developed with the purpose to be easy and flexible in use.
Eventually DtlTraders will offer several trader types which allow creation of admin shops, player-owned shops, enchant shops, bankers and similar. The author is also working hard to make an auction house npc a reality.  
 
It will have a big variety of trader types, allowing to create "Admin shops", "Player shops", "Enchant Shops", "Bankers" and maybe "Auction house npcs". And this isn't the end, so if you got an idea for a trader, just mail it, and I will see if it possible to create with this plugin.


This plugin was developed to be flexible and easy in use.


== Navigation ==
== Navigation ==
Line 35: Line 34:


== Features ==
== Features ==
So far this plugin got a possibility to use four different trader types, each has his own exceptional purpose.
At this time four different trader types are available, each has its own specific purpose.


# Server trader - this type is used as a Admin shop, so it should be only managed by Administrators
# Server trader - Admin shop, fully customizable to meet your needs.
# Player trader - this type allows a player to manage his own trader, so he can set items he want to sell and also set items he wan' to buy
# Player trader - Allows players to set up and manage their own traders.
# Money banker (beta) - an money banker is like a exchange spot, you can display player's money as an item (set in the config) and manage the money buy adding/removing items from it (I've tested him only on my server, so it can be buggy, feel free to test)
# Money banker (beta) - Enables the use of in-game items as a currency (set in the config). You can withdraw your money as an item to store or trade with another player. (Only limited testing was done, feel free to report any problems)
# Player banker (beta) - atm it lacks only permissions setup, but it can be still buggy so be aware
# Player banker (beta) - atm it lacks only permissions setup, but it can be still buggy so be aware


=== Locale support ===
=== Locale support ===
You can change mostly any message in the plugin, so if you are running a German server you can change all messages to German.
Almost any message displayed by this plugin can be very easily modified.
I'm also looking for some people who are willing to help translate this into few other languages :)
 
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 />
<br />
Line 59: Line 61:


# Download the latest build at: http://dev.bukkit.org/server-mods/dtltraders/  
# Download the latest build at: http://dev.bukkit.org/server-mods/dtltraders/  
# Put the **dtlTrader.jar** file in the plugins directory
# Put the '''dtlTrader.jar''' file in the plugins directory


The plugin will generate default configuration files when it is run for the first time.
The plugin will generate default configuration files when it is run for the first time.
Installation is explained [https://github.com/Dandielo/DtlCitizensTrader/wiki/Installation here] with configuration nodes


==== Configuration ====
==== Configuration ====
Line 74: Line 74:


=== Creating a trader ===
=== Creating a trader ===
To create a trader you can add a trait to an existing npc by using this command  
To create a trader you can add a trait to an existing npc by using the following command:
<br />
<br />
'''/trait trader'''
'''/trait trader'''
<br />
<br />
and then you will need to re-spawn it
be sure to respawn the npc for the changes to take effect.
<br />
<br />
<br />
<br />
Another way is to create the trader already with this trait using
There are two ways you can accomplish the above when creating a completely new character. The first one is to use:
<br />
<br />
'''/npc create name here -- trait trader'''
'''/npc create ''trader name'' -- trait trader'''
<br />
<br />
<br />
<br />
And the last way is using the '''trader''' command. It has 3 optional arguments allowing to set the type, wallet (for traders) and entity type.
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.
You can set the arguments in any order.
<br />
<br />
'''/trader create trader name [t:<trader-type>] [w:<wallet-type>] [e:<entity-type>]'''
'''/trader create ''trader name'' [t:<trader-type>] [w:<wallet-type>] [e:<entity-type>]'''


<br />
<br />
if you don't supply any arguments it will create a "server trader" with the "infinite wallet"
if you don't supply any arguments the plugin will default to a server trader type with infinite wallet.


=== Creating a banker ===
=== Creating a banker ===
Bankers can be only created by the '''/trader''' command.
Bankers can only be created by using the '''/trader''' command.
'''/trader create Name t:money-bank'''
'''/trader create ''Name'' t:money-bank'''
or
or
'''/trader create Name t:player-bank'''
'''/trader create ''Name'' t:player-bank'''




=== Commands ===
=== Commands ===
A full description of all used commands you can find [http://wiki.citizensnpcs.com/DtlTraders/Commands here].
A complete list of available commands and their description can be found [http://wiki.citizensnpcs.com/DtlTraders/Commands here].


=== Permissions ===
=== Permissions ===
A full list of used permissions is available [https://github.com/Dandielo/DtlCitizensTrader/wiki/Permissions here].
A complete list of permission nodes and their description can be found [http://wiki.citizensnpcs.com/DtlTraders/permissions here].


=== Types ===
=== Types ===
Here you can find the whole list of all [https://github.com/Dandielo/DtlCitizensTrader/wiki/Trader-Types Trader Types].
A list of supported trader types can be found [https://github.com/Dandielo/DtlCitizensTrader/wiki/Trader-Types Trader here].


<br />
<br />
<br />
<br />
== More information ==
== More information ==
There is still a lot of information to add or update here and in the wiki, but I will do this everyday. If something is not clear you can find me on the '''[http://esper.net/publicirc.php esper.net IRC]''' channel [irc://[email protected] #dtlTraders]. Byt sometimes I don't got the time to be there ;<
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://[email protected] #dtlTraders]. You can also e-mail me at [email protected] .

Revision as of 09:54, 10 September 2012

File:DltTraders.png

DtlTraders


Author dandielo
Version 1.9 Beta
Citizens build 2.0 dev build #294
Other dependencies Citizens 2.0. Vault and an economy plugin
Download Link
Description: Trader trait for Citizens 2.0. Issues page

This page will change rapidly during the whole "Beta" phase, keep in mind that the plugin version you are running may quickly become outdated!

Eventually DtlTraders will offer several trader types which allow creation of admin shops, player-owned shops, enchant shops, bankers and similar. The author is also working hard to make an auction house npc a reality.

This plugin was developed to be flexible and easy in use.

Navigation

Navigation
Usage Managing | Trading | Banking
Configuration Configuration | Commands | Permissions | Locale
Types Traders | Bankers




Features

At this time four different trader types are available, each has its own specific purpose.

  1. Server trader - Admin shop, fully customizable to meet your needs.
  2. Player trader - Allows players to set up and manage their own traders.
  3. Money banker (beta) - Enables the use of in-game items as a currency (set in the config). You can withdraw your money as an item to store or trade with another player. (Only limited testing was done, feel free to report any problems)
  4. Player banker (beta) - atm it lacks only permissions setup, but it can be still buggy so be aware

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.



Installation

Dependencies

  1. Citizens 2.0
  2. Vault
  3. economy plugin (vault compatible)

Installation steps

  1. Download the latest build at: http://dev.bukkit.org/server-mods/dtltraders/
  2. Put the dtlTrader.jar file in the plugins directory

The plugin will generate default configuration files when it is run for the first time.

Configuration

All configuration nodes can be found here http://wiki.citizensnpcs.com/DtlTraders/config




How to start

Creating a trader

To create a trader you can add a trait to an existing npc by using the following command:
/trait trader
be sure to respawn the npc for the changes to take effect.

There are two ways you can accomplish the above when creating a completely new character. The first one is to use:
/npc create trader name -- trait trader

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.
/trader create trader name [t:<trader-type>] [w:<wallet-type>] [e:<entity-type>]


if you don't supply any arguments the plugin will default to a server trader type with infinite wallet.

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


Commands

A complete list of available commands and their description can be found here.

Permissions

A complete list of permission nodes and their description can be found here.

Types

A list of supported trader types can be found Trader here.



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 esper.net IRC channel #dtlTraders. You can also e-mail me at [email protected] .