DtlTraders: Difference between revisions

From Citizens Wiki

No edit summary
No edit summary
 
(33 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Trait
<div class="infobox" style="width: 295; font-size: 12px; background: #FFFFFF; float: right; border: 1px solid #CCC; margin-left:2.5em; padding: 9px;">
| PICTURE      = DltTraders.png
{{Box|
| AUTHOR      = dandielo
BORDER = #CCC|
| NAME        = dtlTraders
BACKGROUND = #80aaff|
| VERSION    = See BukkitDev Page
WIDTH = 275|
| CITIZENSBUILD  = See BukkitDev Page
ALIGN = RIGHT|
| DEVSTATUS    = Beta
ICON = [[File:dtlTraders.png|450px]] |
| DEPENDS    = Citizens 2.0, Vault, and an economy plugin
HEADING = ''' <span style="font-size:150%; line-height: 1.31em;"><font color="#80aaff"><center>dtlTraders</center></font></span> ''' |
| DOWNLOADLINK  = http://dev.bukkit.org/server-mods/dtltraders/
CONTENT =
| DESCRIPTION  = Trader trait for Citizens 2.0. [https://github.com/Dandielo/DtlCitizensTrader/issues Issues page]
<div class="padded" style="padding: 19px; font-family:camingodos-web, Helvetica; font-size:110%;">
}}


DtlTraders is a shop and economy plugin for Citizens2
''' dtlTraders ''' was created to easily setup admin shops for your server.
Make and manage your shops with a GUI. Seriously, no hassle with configs and commands ;)


<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>
''' Original license: ''' MIT License


''' Version: ''' 3.0.8


''' Author: ''' Dandielo
''' Status: ''' Abandoned.
''' Source: ''' Original source code can be found on [https://github.com/Dandielo/dtlTraders GitHub]
</div>
}}
</div>
== About ==
<span style="font-size:200%; line-height: 1.31em;"><font color="red"><center>This page is outdated, an external author maintains a fork on [https://www.spigotmc.org/resources/dtltraders.35890/ Spigot], they provide support on [https://discord.gg/fyabsMF Discord]</center></font></span>
'''dtlTraders''' was a trait for Citizens2 allowing to use NPCs as merchants.
Creating a basic trader and managing his stock is really easy, you need to know only one simple command (/trait trader) and all other things are achieved by using the provided '''GUI'''.
However you are not forced to use the trader interface if you don't want to, this plugin comes along with a bunch of commands, and a templating feature called '''patterns''', this allows you to create, change, extend, merge shops in any way you want!
You can also manage items and prices in shops using permissions, allowing you to change the shop content depending when a player has the required permission!
Also if you want you can translate each end-user part of the plugin into your language, as a result, this plugin also comes along with ready and built in translations into some languages.


== Features ==
== Features ==
* Allows to use 3 different trader types, each type has his own features
* Use price patterns to create pricing tiers for your '''VIP''' ranks
* Use item patterns to set prices for damaged items!
* Displays prices using the new '''Bukkit API''' for item lores and names!
* Use one of 7 wallets that may affect the economy in different ways


== How to install ==
All working features, you can use with version '''3.0.8'''
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.<br />
After you gathered all of them you can start using dtlTraders.<br /><br />
''All default permissions to manage a trader should be added by default when you are '''Op'''.''


== How to start ==
* '''Selling''' items to players
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 />
* '''Buying''' items from players
Available types are listed below with a short description and basic information what features this types use.
* Easy adding, editing and removing items from a trader stock
* Easy price setting mechanism
* Allowing to open and set a '''sub-inventory''' with more specific amount choices for items
* Prices set can apply to a unit or to the whole stack
* Prices are calculated always for each added amount ''(in the sub-inventory)'' automatically and on the fly
* Supporting '''ALL custom items''' the bukkit API provides!
* Supporting '''4 attribute modifiers''' described [http://minecraft.gamepedia.com/Attribute here]!
* A lot of '''settings''', you can change to fit your needs
* A '''advanced translation system''' allowing almost everything to translate!
* Patterns allowing to '''setup traders even faster and permissions specific'''!
* Pattern system along with the '''default-pattern''' allows to create shops using '''just one command'''!!!
* The plugin has it's own API allowing to create custom Trader types and item attributes!
* Much more incoming!


=== 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.
* '''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 ===
== Getting started ==
* '''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''.
* '''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.


<!--
To get this plugin working you will need to get the following plugins:
* '''Citizens2'''
* '''Vault'''
* Vault supported economy plugin, like '''''BOSEconomy, Fe'''''
* Vault supported permission plugin, like '''''PermissionEx, Groupmanager'''''
 
After you got all of them you can just simply put the '''dtlTradersx.x.x.jar''' into the plugin directory and start using this plugin.
 
For the most basic setup you need only to know one command, '''/trader create <name>''' that creates a trader or simply create an NPC and add the '''/trait trader''' to it.
 
 
== How to: ==
 
Here are a bunch of helpful tutorials and links that can you help setting up a trader. You can also find here information about the advanced setup of this plugin.
 
If you lack some information you can always send US a mail to [email protected]
 
=== Basic setup ===
 
This [http://wiki.citizensnpcs.co/DtlTraders/basics tutorial] shows how to create a trader from scratch, how to add, edit and remove items.
It shows you how to set prices, manage stock item flags and how to use the '''multiple amounts''' feature.
 
I will also describe some config values, how they affect the game and '''in-game management''' of a trader and also which of them are trader specific.
 
=== Configuration ===
 
http://wiki.citizensnpcs.co/DtlTraders/config


<br />
=== Commands and Permissions ===
=== Locale support ===
Almost any message displayed by this plugin can be very easily modified.


DtlTraders is available in english only at this moment.
http://wiki.citizensnpcs.co/DtlTraders/Commands


If you are willing to help translate this plugin to a different languange please contact the author.
http://wiki.citizensnpcs.co/DtlTraders/permissions
<br />


== Installation ==
=== Language and translations ===


==== Dependencies ====
=== Advanced setup ===
#Citizens 2.0 or 2.0.1
#Vault
#economy plugin (vault compatible)
<br />


==== Installation steps ====
=== Patterns ===
# 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) ====
=== Extending ===  
{{#ev:youtube|PHQZE94GG88|420}}


== More information ==
== Credits and thanks ==
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 ==
{| class="wikitable" style="text-align: center; width: 500px"
{| class="wikitable" style="text-align: center; width: 500px"
|-
|-
! style="width: 100%; background-color:#ADD8E6" colspan="2" | '''DtlTraders'''
! style="width: 100%; background-color:#ADD8E6" colspan="2" | '''DtlTraders'''
|-
|-
| Configuration || <!--| [http://wiki.citizensnpcs.com/DtlTraders/config Configuration] -->| [http://wiki.citizensnpcs.com/DtlTraders/Commands Commands] | [http://wiki.citizensnpcs.com/DtlTraders/permissions Permissions] <!--| [http://wiki.citizensnpcs.com/DtlTraders/locale Locale] -->
| Configuration || | [http://wiki.citizensnpcs.co/DtlTraders/config Configuration] | [http://wiki.citizensnpcs.co/DtlTraders/Commands Commands] | [http://wiki.citizensnpcs.co/DtlTraders/permissions Permissions] | [http://wiki.citizensnpcs.co/DtlTraders/locale Locale]  
|-
|-
| Usage || <!--| [http://wiki.citizensnpcs.com/DtlTraders/managing Managing] | [http://wiki.citizensnpcs.com/DtlTraders/trading Trading] | [http://wiki.citizensnpcs.com/DtlTraders/banking Banking] |--> [http://wiki.citizensnpcs.com/DtlTraders/patterns Patterns]
| Usage ||| [http://wiki.citizensnpcs.co/DtlTraders/managing Managing] | [http://wiki.citizensnpcs.co/DtlTraders/trading Trading] | [http://wiki.citizensnpcs.co/DtlTraders/banking Banking] |[http://wiki.citizensnpcs.co/DtlTraders/patterns Patterns]
|-
|-
| Types || <!--| [http://wiki.citizensnpcs.com/DtlTraders/traders Traders] | [http://wiki.citizensnpcs.com/DtlTraders/bankers Bankers] <!--| [http://wiki.citizensnpcs.com/DtlTraders/auctionhouse Auction House] | [http://wiki.citizensnpcs.com/DtlTraders/wallets Wallets]-->
| Types || | [http://wiki.citizensnpcs.co/DtlTraders/traders Traders] | [http://wiki.citizensnpcs.co/DtlTraders/bankers Bankers] <!--| [http://wiki.citizensnpcs.co/DtlTraders/auctionhouse Auction House] | [http://wiki.citizensnpcs.co/DtlTraders/wallets Wallets]
|-
|-
| Denizen Support || <!--| [http://wiki.citizensnpcs.com/DtlTraders/denizen/commands Commands] | [http://wiki.citizensnpcs.com/DtlTraders/denizen/triggers Triggers] -->
| Denizen Support || | [http://wiki.citizensnpcs.co/DtlTraders/denizen/commands Commands] <!--| [http://wiki.citizensnpcs.co/DtlTraders/denizen/triggers Triggers]  
|}
|}
-->

Latest revision as of 12:29, 16 December 2022

DtlTraders.png
dtlTraders

dtlTraders was created to easily setup admin shops for your server. Make and manage your shops with a GUI. Seriously, no hassle with configs and commands ;)

Original license: MIT License

Version: 3.0.8

Author: Dandielo

Status: Abandoned.

Source: Original source code can be found on GitHub


About

This page is outdated, an external author maintains a fork on Spigot, they provide support on Discord

dtlTraders was a trait for Citizens2 allowing to use NPCs as merchants.

Creating a basic trader and managing his stock is really easy, you need to know only one simple command (/trait trader) and all other things are achieved by using the provided GUI.

However you are not forced to use the trader interface if you don't want to, this plugin comes along with a bunch of commands, and a templating feature called patterns, this allows you to create, change, extend, merge shops in any way you want! You can also manage items and prices in shops using permissions, allowing you to change the shop content depending when a player has the required permission!

Also if you want you can translate each end-user part of the plugin into your language, as a result, this plugin also comes along with ready and built in translations into some languages.

Features

All working features, you can use with version 3.0.8

  • Selling items to players
  • Buying items from players
  • Easy adding, editing and removing items from a trader stock
  • Easy price setting mechanism
  • Allowing to open and set a sub-inventory with more specific amount choices for items
  • Prices set can apply to a unit or to the whole stack
  • Prices are calculated always for each added amount (in the sub-inventory) automatically and on the fly
  • Supporting ALL custom items the bukkit API provides!
  • Supporting 4 attribute modifiers described here!
  • A lot of settings, you can change to fit your needs
  • A advanced translation system allowing almost everything to translate!
  • Patterns allowing to setup traders even faster and permissions specific!
  • Pattern system along with the default-pattern allows to create shops using just one command!!!
  • The plugin has it's own API allowing to create custom Trader types and item attributes!
  • Much more incoming!


Getting started

To get this plugin working you will need to get the following plugins:

  • Citizens2
  • Vault
  • Vault supported economy plugin, like BOSEconomy, Fe
  • Vault supported permission plugin, like PermissionEx, Groupmanager

After you got all of them you can just simply put the dtlTradersx.x.x.jar into the plugin directory and start using this plugin.

For the most basic setup you need only to know one command, /trader create <name> that creates a trader or simply create an NPC and add the /trait trader to it.


How to:

Here are a bunch of helpful tutorials and links that can you help setting up a trader. You can also find here information about the advanced setup of this plugin.

If you lack some information you can always send US a mail to [email protected]

Basic setup

This tutorial shows how to create a trader from scratch, how to add, edit and remove items. It shows you how to set prices, manage stock item flags and how to use the multiple amounts feature.

I will also describe some config values, how they affect the game and in-game management of a trader and also which of them are trader specific.

Configuration

http://wiki.citizensnpcs.co/DtlTraders/config

Commands and Permissions

http://wiki.citizensnpcs.co/DtlTraders/Commands

http://wiki.citizensnpcs.co/DtlTraders/permissions

Language and translations

Advanced setup

Patterns

Extending

Credits and thanks