DtlTraders

From Citizens Wiki
Jump to: navigation, search
dtlTraders

dtlTraders is a trait for Citizens2 allowing to create simple shops or advanced shop systems.

Author: dandielo

Version: 3.0.8

Status: Release, in development

License: MIT License

Source: The source code can be found on GitHub

Issues and tickets: Any tickets should be created on this page GitHub Issues

CI builds: Check Jenkins for latest builds, thanks to DrBix

Maven Repo for artifacts of this plugin can be found here

IRC: #dtlProjects on esper.net

WebPage: Some day I will link it :P


About

dtlTraders is 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 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. If you want to contribute a translation make a pull request on the GitHub page.


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
  • Vault supported permission plugin, like PermissionEx

After you got all of them you can just simply put the dtlTraders.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 trader trait 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 create a ticket on the issues page on GitHUb

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