Currencies

Real in-game output from Currencies 3.3.0 on a local throwaway Paper 1.21.11 test server: the commands were typed by a scripted bot client, and the chat it received is drawn as Minecraft-style chat (typed commands appear in the input bars; grey lines say what happened between commands).

Description

Currencies is an expansion for Medieval Factions that allows faction owners to create and mint local currencies, which paves the way for the simulation of local economies.

Supported Minecraft Versions

This plugin is supported on the Minecraft versions listed in minecraft-versions.json: currently 1.19.4, 1.21.11, 26.2 and 26.3 (Spigot and its forks). Every stable release is booted on a real server of each of these versions before it is published, and every build checks that the plugin only uses Bukkit API that exists on all of them. Other versions from 1.19.4 onwards are expected to work but are not tested. To support another version, add it to the file: both checks pick it up.

Installation

First Time Installation

1. Download the plugin from SpigotMC.
2. Place the jar in the plugins folder of your server.
3. Restart your server.

Dependencies

This plugin depends on Medieval Factions in order to work.

Compatibility: Currencies v3.0.0 was enabled against Medieval Factions 7.0.0 by the dependents gate before Medieval Factions 7.0.0 was published.

Other Medieval Factions expansions: Fiefs (sub-factions), Democracy (elections), Bluemap_MedievalFactions (claims on a BlueMap web map). All of them are listed in the Medieval Factions README.

Currencies 2.x does not enable on Medieval Factions 5.8 or newer. Use Currencies 3.0.0 or later.

Usage

Documentation

• User Guide – Getting started and common scenarios
• Commands Reference – Complete list of all commands
• Configuration Guide – Detailed configuration options

Wiki & Additional Resources

• Wiki Guide
• FAQ

Support

You can find the support Discord server here.

Experiencing a bug?

Please fill out a bug report here.

Contributing

• CONTRIBUTING.md
• Notes for Developers

Testing

Unit Tests

Linux:

./gradlew clean test

Windows:

.\gradlew.bat clean test

If you see BUILD SUCCESSFUL, the tests have passed.

Development

Test Server with Plugin Hot-Reloading

A Docker-based test server is available for development.

Setup

1. Copy sample.env to .env and configure as needed.
2. Build the plugin: ./gradlew build
3. Start the test server: ./up.sh

Stopping the Test Server

./down.sh

Authors and Acknowledgement

Developers

Name	Main Contributions
Daniel Stephenson	Creator
alyphen	Wrote Currencies 2 — the Kotlin rewrite, the jOOQ/Flyway database storage layer, and the coinpurse and currency item systems built on it
Deej	Added the FurnaceHandler
tdlotrring	Fixed a bug with minting costing power even upon failure
Rykurock	Corrected some usage messages and fixed some typos

It was Ricortix's suggestion to create a plugin like this one.

License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0).

You are free to use, modify, and distribute this software, provided that:

• Source code is made available under the same license when distributed.
• Changes are documented and attributed.
• No additional restrictions are applied.

See the LICENSE file for the full text of the GPL-3.0 license.

Roadmap

• Known Bugs
• Planned Features
• Planned Improvements

Changelog

• CHANGELOG.md

Project Status

This project is in active development.

bStats

You can view the bStats page for the plugin here.

Usage reporting

Usage reporting is on by default: when the plugin is enabled, and each time /currency or /coinpurse is used, it sends its name, its version and the command's name (startup and command events) to https://trace.danielstephenson.dev so it is known which plugins are actually in use. Nothing about players, worlds, IPs, or anything typed after a command is sent. The plugin says on every startup whether reporting is on. Each event also carries a random server ID (the server-id line in plugins/trace/config.yml) so servers can be counted rather than events. It identifies no person, account or IP address; delete the line to get a new one.

To turn it off:

• for this plugin: usage-reporting.enabled: false in plugins/Currencies/config.yml
• for every plugin on the server that reports this way: enabled: false in plugins/trace/config.yml (created the first time such a plugin starts)
• for the whole process: the environment variable TRACE_USAGE_REPORTING=off or DO_NOT_TRACK=1

Details: https://danielstephenson.dev/usage-reporting