HyperMerchant

From Citizens Wiki

Revision as of 23:02, 16 October 2013 by Shmancelot (talk | contribs)

HyperMerchant

HyperMerchant is a merchant npc for use with HyperConomy shops.

Features include:

  • An easy to use Inventory based GUI for your players to buy and sell from your HyperConomy shops.
  • Should work nicely with HyperConomy shop permissions.
  • Toggleable Merchant off-duty mode. Close any store temporarily with a simple command.
  • Simple commands to change NPC Greeting, Farewell, Off-Duty, and Deny Service/No Permission messages.


Where to get latest version

HyperMerchant 1.27 is the latest release on bukkitdev. The latest dev build is available with the project's source code on github.

HyperMerchant Versions 1.27 and below requires version 0.972 or 0.973 of HyperConomy.

HyperMerchant Versions 1.28 and above requires version 0.974 of HyperConomy. Currently these are somewhat expirimental in nature as there have been numerous code changes and feature additions in HyperConomy, most notably player owned shops.


How to install

Just copy the HyperMerchant.jar into your plugin folder


How to use

  1. Have a HyperConomy shop already set up.
  2. Create an npc: /create npc my_shopkeeper
  3. Assign npc the hypermerchant trait: /trait hypermerchant
  4. Assign npc to the shop: /hmerchant setshop shop-name

That is it. You can now open that store's menu by interacting with my_shopkeeper.

There is a short video demonstrating most of the plugin functionality at bukkitdev.


Other npc commands

  • /hmerchant offduty - toggle npc off-duty mode.
  • /hmerchant greeting Hi, welcome to my shop. --- assign what npc will say when clicked upon.
  • /hmerchant farewell Thanks for the money, dude! --- assign what npc will say when store menu is closed.
  • /hmerchant closed Sorry, im on my lunch break. --- assign what npc will say when set to off-duty mode.
  • /hmerchant deny You are not permitted to shop here. --- assign what npc will say if player doesn't have proper permissions.
  • /hmerchant setshop shop_name_here --- assign what shop's inventory is displayed when npc is clicked on.

The above commands all operate upon the currently selected npc, unless the --id flag is specified:

  • /hmerchant greeting Hi, welcome to my shop. --id 71

or

  • /hmerchant --id 71 greeting Hi, welcome to my shop.


HyperMerchant also includes the following conveniance commands:

  • /remotemenu [shopname] - open a shop's menu from anywhere.
  • /shopmenu - open the menu of the shop you are standing in.
  • /rslist - list the names of all stores that can be accessed with /remotemenu command.


permissions:

  hypermerchant.*:
     description: Gives access to all HyperMerchant commands
     children:
        hypermerchant.menu: true
        hypermerchant.remote: true
        hypermerchant.npc: true
        hypermerchant.manage: true
  hypermerchant.menu:
     description: Allow use of the /shopmenu command.
     default: true
  hypermerchant.npc:
     description: Allow interaction with hypermerchant npc.
     default: true
  hypermerchant.remote:
     description: Allow use of the /remotemenu command.
     default: op
  hypermerchant.manage:
     description: Allow use of the /hmerchant command.
     default: op