TNE Docs
  • Getting Started
    • Welcome
    • Currencies Key Concepts
    • Creating a Currency
    • Breakdown of Main Currency Configuration File
    • Breakdown of Denomination Configuration File
    • Commands & Permissions
    • PlaceholderAPI Placeholders
  • FAQ HOWTO
    • HOW TO: Limit Access to Currencies
    • HOWTO: Contribute Translation
    • HOWTO: Share Balances Across Servers
  • Developers
    • Welcome Developers
    • Contributing
    • API Usage
    • Callbacks
    • Platform Implementations
    • Creating Custom Account Type
    • Creating Custom Balance Handlers
    • Creating Custom Account Statuses
    • Creating Custom Balance Format Rule
    • Creating Custom Currency Loader & Saver
    • Creating Custom Currency Type
    • Creating Custom Transaction Checks
    • Creating Custom TaxType
    • Creating Custom Transaction Type
Powered by GitBook
On this page
  • Key Terms
  • Folder Structure and Terms
  1. Getting Started

Currencies Key Concepts

This page provides definitions for key terms used in the currency system documentation.

Key Terms

1. Currency

A unit of exchange used to facilitate transactions in the Minecraft server. Currencies can be virtual, item-based, or experience-based.

2. Denomination

Denominations are subdivisions of a currency, representing specific values of that currency. For example, in the "USD" currency:

  • A "Dollar" is the major denomination.

  • A "Cent" is the minor denomination.

Each denomination must be defined in a separate YAML file within the folder matching the currency's Identifier.

3. Item-Based Currency

An item-based currency uses Minecraft items to represent monetary units. For example, gold nuggets or custom items with specific textures may act as physical currency in the game.

4. Experience-Based Currency

An experience-based currency uses a player's experience points as the currency. Transactions add or deduct experience points directly from the player's total.

5. Virtual Currency

A virtual currency exists only as data tracked by the server. It is not tied to any physical item or experience points but is used for in-game transactions such as shops or trading.


Folder Structure and Terms

Folder Structure

  • Main Currency File: The primary YAML file defining the overall currency configuration, located directly in the currencies folder.

  • Denomination Folder: A folder named after the currency's Identifier, containing YAML files for each denomination.

Example:

For the currency "USD":

- currency/
  - USD/
    - one.yml    # Denomination file for "One"
    - penny.yml  # Denomination file for "Penny"
- USD.yml         # Main configuration file for "USD"

Notes

  • The Identifier in the main currency file must match the folder name for denominations.

PreviousWelcomeNextCreating a Currency

Last updated 2 months ago