DtlTraders: Difference between revisions

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
	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

Latest revision as of 12:29, 16 December 2022

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.

@@ 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    = 1.9 Beta
+WIDTH = 275|
-| CITIZENSBUILD  = 2.0 dev build #294
+ALIGN = RIGHT|
-| DEVSTATUS    = InDev
+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%;">
-}}
-<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>
+''' 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 ;)
-This plugin was developed with the purpose to be easy and flexible in use.
+''' Original license: ''' MIT License
-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.
+''' Version: ''' 3.0.8
+''' Author: ''' Dandielo
-== Navigation ==
+''' Status: ''' Abandoned.
-{| class="wikitable" style="text-align: center; width: 500px"
-|-
+''' Source: ''' Original source code can be found on [https://github.com/Dandielo/dtlTraders GitHub]
-! style="width: 100%; background-color:#ADD8E6" colspan="2" | '''Navigation'''
-|-
+</div>
-| 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]
+}}
-|-
+</div>
-| 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]
-|-
-| 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]-->
+== 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.
-<br />
-<br />
 == Features ==
-So far this plugin got a possibility to use four different trader types, each has his own exceptional purpose.
-# Server trader - this type is used as a Admin shop, so it should be only managed by Administrators
+All working features, you can use with version '''3.0.8'''
-# 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
-# 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)
-# Player banker (beta) - atm it lacks only permissions setup, but it can be still buggy so be aware
-=== Locale support ===
+* '''Selling''' items to players
-You can change mostly any message in the plugin, so if you are running a German server you can change all messages to German.
+* '''Buying''' items from players
-I'm also looking for some people who are willing to help translate this into few other languages :)
+* 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!
-<br />
-<br />
-== Installation ==
-==== Dependencies ====
+== Getting started ==
-#Citizens 2.0
+To get this plugin working you will need to get the following plugins:
-#Vault
+* '''Citizens2'''
-#economy plugin (vault compatible)
+* '''Vault'''
+* Vault supported economy plugin, like '''''BOSEconomy, Fe'''''
+* Vault supported permission plugin, like '''''PermissionEx, Groupmanager'''''
-==== Installation steps ====
+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.
-# Download the latest build at: http://dev.bukkit.org/server-mods/dtltraders/
+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.
-# Put the **dtlTrader.jar** file in the plugins directory
-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
+== How to: ==
-==== Configuration ====
+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.
-All configuration nodes can be found here http://wiki.citizensnpcs.com/DtlTraders/config
+If you lack some information you can always send US a mail to [email protected]
-<br />
+=== Basic setup ===
-<br />
-== How to start ==
-=== Creating a trader ===
+This [http://wiki.citizensnpcs.co/DtlTraders/basics tutorial] shows how to create a trader from scratch, how to add, edit and remove items.
-To create a trader you can add a trait to an existing npc by using this command
+It shows you how to set prices, manage stock item flags and how to use the '''multiple amounts''' feature.
-<br />
-'''/trait trader'''
-<br />
-and then you will need to re-spawn it
-<br />
-<br />
-Another way is to create the trader already with this trait using
-<br />
-'''/npc create name here -- trait trader'''
-<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.
-You can set the arguments in any order.
-<br />
-'''/trader create trader name [t:<trader-type>] [w:<wallet-type>] [e:<entity-type>]'''
-<br />
+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.
-if you don't supply any arguments it will create a "server trader" with the "infinite wallet"
-=== Creating a banker ===
+=== Configuration ===
-Bankers can be only created by the '''/trader''' command.
-'''/trader create Name t:money-bank'''
-or
-'''/trader create Name t:player-bank'''
+http://wiki.citizensnpcs.co/DtlTraders/config
-=== Commands ===
+=== Commands and Permissions ===
-A full description of all used commands you can find [http://wiki.citizensnpcs.com/DtlTraders/Commands here].
-=== Permissions ===
+http://wiki.citizensnpcs.co/DtlTraders/Commands
-A full list of used permissions is available [https://github.com/Dandielo/DtlCitizensTrader/wiki/Permissions here].
-=== Types ===
+http://wiki.citizensnpcs.co/DtlTraders/permissions
-Here you can find the whole list of all [https://github.com/Dandielo/DtlCitizensTrader/wiki/Trader-Types Trader Types].
-<br />
+=== Language and translations ===
-<br />
-== More information ==
+=== Advanced setup ===
-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://dtlTraders@irc.esper.net #dtlTraders]. Byt sometimes I don't got the time to be there ;<
+=== Patterns ===
+=== Extending ===
+== Credits and thanks ==
+<!--
+{| class="wikitable" style="text-align: center; width: 500px"
+|-
+! style="width: 100%; background-color:#ADD8E6" colspan="2" | '''DtlTraders'''
+|-
+| 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.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.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.co/DtlTraders/denizen/commands Commands] <!--| [http://wiki.citizensnpcs.co/DtlTraders/denizen/triggers Triggers]
+|}
+-->