PropGuardMT5/docs/product-spec.md
2026-06-11 20:14:27 +03:00

137 lines
2.6 KiB
Markdown

# PropGuard MT5 Product Spec
## Target User
Prop firm and funded-account traders using MetaTrader 5, especially manual traders who need visible account-rule protection.
## Core Promise
Help traders avoid preventable rule breaches by monitoring risk limits and locking behavior after limits are reached.
## Non-Promise
PropGuard MT5 does not predict market direction, provide signals, or guarantee profits.
## Rule Model
### Daily Loss Base
User-selectable:
- `StartDayBalance`
- `StartDayEquity`
- `IntradayHighEquity`
Default: `StartDayEquity`
### Daily Reset
User-selectable:
- `BrokerMidnight`
- `CustomServerTime`
All reset calculations use broker-server time.
### Breach Actions
User-selectable:
- `AlertOnly`
- `BlockNewTrades`
- `CloseAllAndBlock`
Default: `BlockNewTrades`
Because MT5 cannot globally reject every manual trade before execution, "block" means the EA enters a locked state, alerts the user, and can optionally close trades opened after the lock.
### Locked Trade Handling
User-selectable:
- `AlertOnly`
- `CloseNewTrades`
Default: `AlertOnly`
### Scope
User-selectable:
- `AccountWide`
- `CurrentSymbol`
- `SymbolList`
Default: `AccountWide`
Risk rules are intended for account-wide prop-firm use. Scope controls which positions the EA acts on and which symbols are counted for trade/lot limits.
## MVP Inputs
- `InpDailyLossLimitPercent`
- `InpDailyProfitTargetPercent`
- `InpOverallDrawdownLimitPercent`
- `InpMaxTradesPerDay`
- `InpMaxLotsPerDay`
- `InpDailyLossBaseMode`
- `InpResetMode`
- `InpResetHour`
- `InpResetMinute`
- `InpDailyBreachAction`
- `InpOverallBreachAction`
- `InpLockedTradeAction`
- `InpScopeMode`
- `InpSymbolsCSV`
- `InpSlippagePoints`
- `InpEnablePopupAlerts`
- `InpEnablePushNotifications`
## MVP Dashboard
Must show:
- Product name and version
- Server time
- Next reset
- Scope
- Daily loss base mode
- Daily base values
- Equity and balance
- Daily loss percent
- Daily profit percent
- Overall drawdown percent
- Trades today
- Lots today
- Lock state
- Lock reason
## Version Strategy
### Free/Lite
- Dashboard
- Daily loss monitoring
- Popup alerts
- Manual close-all button
### Pro
- All breach actions
- Locked trade handling
- Symbol-list scope
- Push notifications
- Presets
- Violation log/export
## First Release Acceptance Criteria
- Compiles in MetaEditor for MT5.
- Can attach to one chart.
- Captures daily baseline.
- Resets at broker midnight or custom server time.
- Displays dashboard.
- Detects daily loss breach.
- Detects overall drawdown breach.
- Detects max trades/lots breach.
- Can close scoped positions via chart button.
- Logs breach reason to Journal.