Setup - AshleyThew/Bank GitHub Wiki

Setup

Overview

This page is the admin installation and first-run checklist. Use it to get Bank running safely before deeper tuning.

How It Works

Bank loads dependency components, then creates runtime config files under plugins/Bank/ on first boot. After files exist, you tune config and restart or reload based on what changed.

Configuration

Initial install steps

  1. Place the Bank jar in plugins/.
  2. Start server once to generate plugins/Bank/ files.
  3. Stop server.
  4. Edit plugins/Bank/config.yml and backend files.
  5. Start server and validate startup logs.

Storage subsystem setup

  • Bank.Save.Type selects SQLITE, MYSQL, or MONGODB.
  • For MySQL, complete plugins/Bank/mysql.yml before switching save type.
  • For MongoDB, complete plugins/Bank/mongo.yml and ensure loader dependency is present.

Reference files:

Bank:
  Save:
    Type: MYSQL

Access-mode subsystem setup

  • Bank.Type.Sign.Enabled: allows sign interaction access.
  • Bank.Type.Block.Enabled: allows registered block access.
  • Bank.Type.Citizens.Enabled: allows NPC trait entry.

Open subset subsystem setup

Bank.Opentype.Subset is a full subsystem that controls what open targets are allowed:

  • Bank.Opentype.Subset.Enabled: master switch.
  • Bank.Opentype.Subset.Command.*: command open restrictions.
  • Bank.Opentype.Subset.Citizens.*: NPC open restrictions.
  • Bank.Opentype.Subset.Sign.*: sign open restrictions.

When this subsystem is enabled, configure each channel explicitly to avoid users being routed to unexpected menus.

Reference file:

Bank:
  Opentype:
    Subset:
      Enabled: true
      Command:
        Enabled: true
      Citizens:
        Enabled: true
      Sign:
        Enabled: true

Commands

  • /bank
  • /bank admin reload
  • /bank admin save

Permissions

Core access and command permissions are documented in Commands and Permissions. For initial setup, confirm players have open and money/exp permissions that match your enabled modes.

Data and Storage

Default save type is SQLITE. Player accounts and transactions are persisted separately from command and GUI config files.

Examples

MySQL production setup:

  1. Set Bank.Save.Type: MYSQL in config.yml.
  2. Fill mysql.yml credentials.
  3. Restart server.

Recommended mysql.yml baseline:

Mysql:
  IP: 127.0.0.1
  Port: 3306
  Database: bank
  Username: bank_user
  Password: change_me

Restricted open setup with subset subsystem:

  1. Set Bank.Opentype.Subset.Enabled: true.
  2. Enable only the channels you want under Bank.Opentype.Subset.Command.Enabled, Bank.Opentype.Subset.Citizens.Enabled, and Bank.Opentype.Subset.Sign.Enabled.
  3. Control specific open actions with command permissions from conf/commands.yml.

Citizens setup:

  1. Install Citizens.
  2. Create NPC and add trait bank-trait.

Troubleshooting

  • If startup reports missing Core, verify dependency installation and restart.
  • If /bank open ... commands do not match expected menu, review Bank.Opentype.Subset.* first.
  • If save backend fails, Bank may fall back to SQLite; verify startup logs before going live.

Related Pages