DtlTraders: Difference between revisions

From Citizens Wiki

(→‎More information: - irc link fix)
No edit summary
 
(85 intermediate revisions by 4 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    = 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 rapidly during the whole "Beta" phase, keep in mind that the plugin version you are running may quickly become outdated!</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 ;)


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


This plugin was developed to be flexible and easy in use.
== Features ==
== Features ==
At this time four different trader types are available, each has its own specific purpose.


# Server trader - Admin shop, fully customizable to meet your needs.
All working features, you can use with version '''3.0.8'''
# Player trader - Allows players to set up and manage their own traders.
# 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
<br />
=== Locale support ===
Almost any message displayed by this plugin can be very easily modified.  


DtlTraders is available in english only at this moment.
* '''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 [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!


If you are willing to help translate this plugin to a different languange please contact the author.
<br />
== Installation ==
==== Dependencies ====
#Citizens 2.0
#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 />
== 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 />


== Navigation ==
== 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 [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
 
=== 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 ==
 
<!--
 
{| 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'''
|-
|-
| 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] -->
| 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]
|-
|-
| 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.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]
|-
|-
| 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]-->
| 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