-
Notifications
You must be signed in to change notification settings - Fork 2
Events Hooks and Extensibility
This page is the single admin guide for external integrations and open access modes. It replaces separate integration pages so setup is done in one place.
Bank integration behavior is split into subsystems:
- Placeholder subsystem: PlaceholderAPI and MVdW values for HUD/scoreboards.
- Citizens subsystem: NPC entry points with bank trait support.
- Block subsystem: admin-registered blocks as bank entry points.
- Sign subsystem: configured sign text opens bank flow.
- Access permission subsystem: behavior checks in
conf/permissions.yml.
Bank also emits a player-loaded event for developers, but server admins usually only need the runtime toggles and permissions listed below.
Primary keys in config.yml:
Bank.Implementation.Placeholder.*Bank.Type.Citizens.EnabledBank.Type.Block.*Bank.Type.Sign.*Bank.Opentype.Subset.*
Reference files:
Placeholder baseline:
Bank:
Implementation:
Placeholder:
Api: true
Mvdw: false
Prefix: bankCitizens and sign/block baseline:
Bank:
Type:
Citizens:
Enabled: true
Block:
Enabled: true
Sign:
Enabled: true
Text: "[Bank]"Integration admin commands:
/bank admin npc setopentypes [types...]/bank admin block add|remove
Common integration and access permissions:
bank.open.signbank.open.citizensbank.open.blockbank.sign.placebank.admin.npc.setopentypesbank.admin.block.addbank.admin.block.remove
Permission-check baseline:
Permission:
Open:
Sign:
Check: true
Permission: bank.open.sign
Citizens:
Check: true
Permission: bank.open.citizens
Block:
Check: true
Permission: bank.open.blockIntegration toggles and block/sign configuration are file-based settings. Per-player account balances and transaction data remain in normal Bank persistence.
Placeholder rollout:
- Install PlaceholderAPI.
- Set
Bank.Implementation.Placeholder.Api: true. - Reload or restart Bank.
- Test a known value in your scoreboard/chat plugin.
Citizens NPC rollout:
- Install Citizens.
- Set
Bank.Type.Citizens.Enabled: true. - Create NPC and run
/trait add bank-trait. - Grant
bank.open.citizens.
Block bank rollout:
- Set
Bank.Type.Block.Enabled: true. - Run
/bank admin block addwhile targeting the block. - Grant
bank.open.block.
Sign bank rollout:
- Set
Bank.Type.Sign.Enabled: trueand confirm sign text. - Grant
bank.open.sign. - If sign placement checks are used, also grant
bank.sign.place.
- Placeholder values not resolving: check implementation flags and installed placeholder plugin.
- Citizens bank trait not working: verify Citizens plugin and type enable flag.
- Block open fails: confirm block was registered and permission check toggle is correct.
- Sign open fails: confirm sign text matches configured marker and permission checks are aligned.
- System Architecture and Lifecycle
- Commands and Permissions
- Account and Balance Model
- Transactions and Money Flow Rules
- Storage and Persistence
- Configuration System
- GUI and Inventory Interactions
- Integrations and Access Modes
- Error Handling and Edge Cases
- Admin Operations and Troubleshooting
- Backup, Recovery, and Migration
- Version Compatibility and Known Limitations
- command_baltop.yml
- commands.yml
- config.yml
- convert.yml
- default_items.yml
- hiscores.yml
- inventories.yml
- itemblacklist.yml
- items.yml
- language.yml
- mysql.yml
- permissions.yml
- sounds.yml
- upgrade.yml
- Discord Support Config:
- command_baltop.yml
- commands.yml
- config.yml
- convert.yml
- default_items.yml
- hiscores.yml
- inventories.yml
- itemblacklist.yml
- items.yml
- language.yml
- mongo.yml
- mysql.yml
- permissions.yml
- sounds.yml Config:
- command_baltop.yml
- commands.yml
- config.yml
- convert.yml
- default_items.yml
- hiscores.yml
- inventories.yml
- itemblacklist.yml
- items.yml
- language.yml
- mongo.yml
- mysql.yml
- permissions.yml
- sounds.yml Config:
- command_baltop.yml
- commands.yml
- config.yml
- convert.yml
- default_items.yml
- hiscores.yml
- inventories.yml
- itemblacklist.yml
- items.yml
- language.yml
- mongo.yml
- mysql.yml
- permissions.yml
- sounds.yml