Giter VIP home page Giter VIP logo

chestshopnotifier's Introduction

ChestShopNotifier

CSN (ChestShop Notifier) is a plugin that records ChestShop transactions to a MySQL database. When a shop owner logs onto the server, they will be presented with an option to view sales from when they were offline.

Downloads

You can download release versions of the plugin from the ChestShopNotifier Bukkit dev page!

Development builds can be found on the Minebench.de Jenkins build server: http://ci.minebench.de/job/ChestShopNotifier/

Installation Instructions

Installing this plugin is simple. Just download and drag ChestShopNotifier.jar into your server's plugins directory.

Next, restart and log into your server. When you try to use /csn history, you'll receive an error that the database isn't connected. Follow these steps to get it working:

  1. Open the plugin folder (/plugins/ChestShopNotifier)
  2. Edit the config.yml with your database settings (feel free to change other config as well)
  3. Save the file
  4. In-game, run /csn reload to reload config and connect to the database.

If it says the database was connected, you're good to go!

Commands

  • /csn help → Shows available commands
  • /csn history [page] → Shows sale history and marks them as read
  • /csn history [username [page]] → Shows sale history of another player
  • /csn clear → Removes as read entries (from the database)
  • /csn cleandatabase → Remove database entries. Parameters:
    --older-than, -o days → Removes entries older than days
    --user, -user username/uuid → Removes entries from a single user only
    --read-only, -r → Removes only read entries, default behaviour
    --all, -a → Removes all entries
  • /csn upload → Forces the plugin to upload all data to the database (in v1.1 and higher this should be only used after database connection problems!)
  • /csn reload → Reloads configuration and connects to database using new config
  • /csn convert → Converts the database table csn to UUIDs. (table csn gets converted in csnUUID and the username table renamed to csnOLD)

Permissions

  • csn.user → Allows user to receive notifications when they log in, and access to /csn history.
  • csn.admin → Super permission node. Access to all commands. (especially upload, reload and convert)

For all permissions take a look at the plugin.yml.

Requirements

  • Functional MySQL server. This plugin only uses MySQL, nothing else.
  • ChestShop installed and running.

Planned Features

To request features open an issue!

  • UUIDsupport done in v1.1.2
  • Look up the sales of offline players done in v1.1.2
  • Ignore ChestShop's Admin Shop done in v1.1.2
  • History pagination done in v1.2
  • Auto updater & version checker
  • Translation system (partially done in v1.1.2, you can set your own messages in the config)

For all changes take a look at the commits!

Demonstration

Preview 1

Preview 2

chestshopnotifier's People

Contributors

baileyherbert avatar frankheijden avatar phemmer avatar phoenix616 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.