305 lines
18 KiB
Markdown
305 lines
18 KiB
Markdown
---
|
|
id: plugin.economy-framework
|
|
title: Economy Framework
|
|
scope: plugins
|
|
status: active
|
|
priority: 10
|
|
visibility: user
|
|
category: Plugin
|
|
tags: plugin, economy-framework
|
|
generated: true
|
|
editable: false
|
|
updated_at: "2026-06-25T12:06:11.231Z"
|
|
---
|
|
# Economy Framework
|
|
Cross-platform currency framework with shared balances and extensible hooks.
|
|
## Metadata
|
|
Plugin ID: economy-framework
|
|
Version: 0.2.9
|
|
Default state: enabled
|
|
## Web Routes
|
|
- /plugins/economy-framework
|
|
- /profile/banking
|
|
- GET /plugins/economy-framework
|
|
- GET /profile/banking
|
|
- POST /plugins/economy-framework/settings/currency
|
|
- POST /profile/banking/settings/currency
|
|
- POST /plugins/economy-framework/settings/platforms
|
|
- POST /profile/banking/settings/platforms
|
|
- POST /plugins/economy-framework/settings/earn
|
|
- POST /profile/banking/settings/earn
|
|
- POST /plugins/economy-framework/settings/tiers
|
|
- POST /profile/banking/settings/tiers
|
|
- POST /plugins/economy-framework/settings/banking
|
|
- POST /profile/banking/settings/banking
|
|
- POST /plugins/economy-framework/settings/responses
|
|
- POST /profile/banking/settings/responses
|
|
- POST /plugins/economy-framework/settings/icon
|
|
- POST /profile/banking/settings/icon
|
|
- POST /plugins/economy-framework/accounts/adjust
|
|
- POST /profile/banking/accounts/adjust
|
|
- POST /plugins/economy-framework/funds/create
|
|
- POST /profile/banking/funds/create
|
|
- POST /plugins/economy-framework/funds/:id/update
|
|
- POST /profile/banking/funds/:id/update
|
|
- POST /plugins/economy-framework/events/create
|
|
- POST /profile/banking/events/create
|
|
- POST /plugins/economy-framework/events/:id/delete
|
|
- POST /profile/banking/events/:id/delete
|
|
## Route Reference
|
|
### MOUNT /plugins/economy-framework
|
|
|
|
- Purpose: Mounts the plugin router at this base WebUI path.
|
|
- Inputs: No request parameters detected by static analysis.
|
|
- Response format: Plugin router mount point.
|
|
- Access: Access is controlled by the mount options and individual plugin routes.
|
|
- Side effects: No direct route action; child routes handle requests.
|
|
- Limits/notes: Mount metadata is inferred from static source scanning.
|
|
|
|
### MOUNT /profile/banking
|
|
|
|
- Purpose: Mounts the plugin router at this base WebUI path.
|
|
- Inputs: No request parameters detected by static analysis.
|
|
- Response format: Plugin router mount point.
|
|
- Access: Access is controlled by the mount options and individual plugin routes.
|
|
- Side effects: No direct route action; child routes handle requests.
|
|
- Limits/notes: Mount metadata is inferred from static source scanning.
|
|
|
|
### GET /plugins/economy-framework
|
|
|
|
- Purpose: Renders or serves the economy-framework plugin page.
|
|
- Inputs: No request parameters detected by static analysis.
|
|
- Response format: HTML page rendered from an EJS view
|
|
- Access: admin access expected; moderator access may be required; logged-in session required or used
|
|
- Side effects: Usually read-only.
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations.
|
|
|
|
### GET /profile/banking
|
|
|
|
- Purpose: Renders the profile banking WebUI page.
|
|
- Inputs: No request parameters detected by static analysis.
|
|
- Response format: HTML page rendered from an EJS view
|
|
- Access: admin access expected; moderator access may be required; logged-in session required or used
|
|
- Side effects: Usually read-only.
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations.
|
|
|
|
### POST /plugins/economy-framework/settings/currency
|
|
|
|
- Purpose: Processes the economy-framework plugin action for settings currency.
|
|
- Inputs: body: `command_aliases`, `command_root`, `currency_name`, `currency_name_plural`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /profile/banking/settings/currency
|
|
|
|
- Purpose: Processes the profile banking settings currency action and stores or applies submitted form data.
|
|
- Inputs: body: `command_aliases`, `command_root`, `currency_name`, `currency_name_plural`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/economy-framework/settings/platforms
|
|
|
|
- Purpose: Processes the economy-framework plugin action for settings platforms.
|
|
- Inputs: body: `platform_discord`, `platform_twitch`, `platform_youtube`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /profile/banking/settings/platforms
|
|
|
|
- Purpose: Processes the profile banking settings platforms action and stores or applies submitted form data.
|
|
- Inputs: body: `platform_discord`, `platform_twitch`, `platform_youtube`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/economy-framework/settings/earn
|
|
|
|
- Purpose: Processes the economy-framework plugin action for settings earn.
|
|
- Inputs: body: `earn_discord_message_amount`, `earn_discord_message_cooldown`, `earn_discord_message_enabled`, `earn_discord_voice_amount_per_min`, `earn_discord_voice_enabled`, `earn_discord_voice_tick_minutes`, `earn_twitch_message_amount`, `earn_twitch_message_cooldown`, `earn_twitch_message_enabled`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /profile/banking/settings/earn
|
|
|
|
- Purpose: Processes the profile banking settings earn action and stores or applies submitted form data.
|
|
- Inputs: body: `earn_discord_message_amount`, `earn_discord_message_cooldown`, `earn_discord_message_enabled`, `earn_discord_voice_amount_per_min`, `earn_discord_voice_enabled`, `earn_discord_voice_tick_minutes`, `earn_twitch_message_amount`, `earn_twitch_message_cooldown`, `earn_twitch_message_enabled`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/economy-framework/settings/tiers
|
|
|
|
- Purpose: Processes the economy-framework plugin action for settings tiers.
|
|
- Inputs: body: `tier_discord_booster_multiplier`, `tier_twitch_broadcaster_multiplier`, `tier_twitch_mod_multiplier`, `tier_twitch_sub_multiplier`, `tier_twitch_vip_multiplier`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /profile/banking/settings/tiers
|
|
|
|
- Purpose: Processes the profile banking settings tiers action and stores or applies submitted form data.
|
|
- Inputs: body: `tier_discord_booster_multiplier`, `tier_twitch_broadcaster_multiplier`, `tier_twitch_mod_multiplier`, `tier_twitch_sub_multiplier`, `tier_twitch_vip_multiplier`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/economy-framework/settings/banking
|
|
|
|
- Purpose: Processes the economy-framework plugin action for settings banking.
|
|
- Inputs: body: `banking_enabled`, `banking_label`, `community_fund_name`, `community_fund_name_plural`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /profile/banking/settings/banking
|
|
|
|
- Purpose: Processes the profile banking settings banking action and stores or applies submitted form data.
|
|
- Inputs: body: `banking_enabled`, `banking_label`, `community_fund_name`, `community_fund_name_plural`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/economy-framework/settings/responses
|
|
|
|
- Purpose: Processes the economy-framework plugin action for settings responses.
|
|
- Inputs: body: `response_key`, `response_mode`, `response_text`, `response_weight`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /profile/banking/settings/responses
|
|
|
|
- Purpose: Processes the profile banking settings responses action and stores or applies submitted form data.
|
|
- Inputs: body: `response_key`, `response_mode`, `response_text`, `response_weight`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/economy-framework/settings/icon
|
|
|
|
- Purpose: Processes the economy-framework plugin action for settings icon.
|
|
- Inputs: file upload: multipart form file data
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state; writes files
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /profile/banking/settings/icon
|
|
|
|
- Purpose: Processes the profile banking settings icon action and stores or applies submitted form data.
|
|
- Inputs: file upload: multipart form file data
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state; writes files
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/economy-framework/accounts/adjust
|
|
|
|
- Purpose: Processes the economy-framework plugin action for accounts adjust.
|
|
- Inputs: body: `amount`, `note`, `target_user_id`, `username`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: moderator access may be required; logged-in session required or used
|
|
- Side effects: writes database state when the called service mutates data
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /profile/banking/accounts/adjust
|
|
|
|
- Purpose: Processes the profile banking accounts adjust action and stores or applies submitted form data.
|
|
- Inputs: body: `amount`, `note`, `target_user_id`, `username`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: moderator access may be required; logged-in session required or used
|
|
- Side effects: writes database state when the called service mutates data
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/economy-framework/funds/create
|
|
|
|
- Purpose: Processes the economy-framework plugin action for funds create.
|
|
- Inputs: body: `description`, `name`, `target_amount`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /profile/banking/funds/create
|
|
|
|
- Purpose: Processes the profile banking funds create action and stores or applies submitted form data.
|
|
- Inputs: body: `description`, `name`, `target_amount`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/economy-framework/funds/:id/update
|
|
|
|
- Purpose: Processes the economy-framework plugin action for funds id update.
|
|
- Inputs: path params: `id`; body: `description`, `name`, `status`, `target_amount`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /profile/banking/funds/:id/update
|
|
|
|
- Purpose: Processes the profile banking funds id update action and stores or applies submitted form data.
|
|
- Inputs: path params: `id`; body: `description`, `name`, `status`, `target_amount`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/economy-framework/events/create
|
|
|
|
- Purpose: Processes the economy-framework plugin action for events create.
|
|
- Inputs: body: `amount`, `name`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /profile/banking/events/create
|
|
|
|
- Purpose: Processes the profile banking events create action and stores or applies submitted form data.
|
|
- Inputs: body: `amount`, `name`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/economy-framework/events/:id/delete
|
|
|
|
- Purpose: Processes the economy-framework plugin action for events id delete.
|
|
- Inputs: path params: `id`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /profile/banking/events/:id/delete
|
|
|
|
- Purpose: Processes the profile banking events id delete action and stores or applies submitted form data.
|
|
- Inputs: path params: `id`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
## Commands
|
|
- No plugin command triggers detected.
|
|
## Source
|
|
Plugin folder: plugins/economy-framework
|