FXAxis
============================================================

Plan. Calculate. Execute.

A professional MetaTrader 5 trading terminal for Windows with
advanced charting, a full drawing-tool suite, a watchlist,
depth-of-market (DOM), and order management -- all connected to
your real MT5 account (demo or live).

Website: https://kalifxlab.com/FXAXIS/


============================================================
TABLE OF CONTENTS
============================================================

  1. What is FXAxis?
  2. Features
  3. Keyboard Shortcuts
  4. Broker Compatibility & Symbol Support
  5. Desktop-App Licensing
  6. Known Limitations
  7. Contact & Support


============================================================
1. WHAT IS FXAxis?
============================================================

FXAxis is a professional MetaTrader 5 (MT5) trading terminal.
Open it and you land straight in a live terminal: a candle chart
with a full drawing toolbar, a watchlist, a depth-of-market
ladder, and an order ticket -- all wired to the MetaTrader 5
account that is logged into your MT5 terminal.

A small local "bridge" service connects the interface to your
running MT5 platform: prices, candles, positions, orders, and
account equity all come from MT5 itself, and trades placed in
FXAxis execute in your real MT5 account.


============================================================
2. FEATURES
============================================================

------------------------------------------------------------
2.1 CHARTING
------------------------------------------------------------
- Candlestick and line chart.
- 8 timeframes: 1m, 5m, 15m, 30m, 1h, 4h, 1d, 1w.
- Volume histogram, OHLC legend, live bid/ask price lines,
  crosshair, and candle countdown.
- Session highlighting (Asia, London, New York) and
  session-break separators.
- Per-symbol chart preferences and saveable chart templates
  (stored locally on your PC).
- Full color customization for every chart element (candles,
  grid, lines, background).

------------------------------------------------------------
2.2 TECHNICAL INDICATORS
------------------------------------------------------------
- SMA    (Simple Moving Average)
- EMA    (Exponential Moving Average)
- RSI    (Relative Strength Index)
- MACD   (Moving Average Convergence Divergence)
- Bollinger Bands
- ATR    (Average True Range)
- Stochastic Oscillator (%K / %D)
- VWAP   (Volume Weighted Average Price)

Multiple instances of the same indicator are supported (for
example, a fast and a slow EMA together). Each indicator has
customizable period, color, line width, and label visibility.

------------------------------------------------------------
2.3 DRAWING TOOLS
------------------------------------------------------------
Lines:      Trend Line, Ray, Extended Line, Horizontal Line,
            Vertical Line, Parallel Channel
Fibonacci:  Fib Retracement, Fib Extension
Shapes:     Rectangle, Ellipse, Triangle, Arrow
Trade:      Long Position, Short Position, Measure
Text:       Text annotations

Additional features:
- Draggable, hideable floating drawing rail.
- Magnet mode (off / weak / strong) for price-level snapping.
- Per-object styling (color, width, line style, labels).
- Object tree panel to select, toggle, and delete drawings.
- Undo / Redo, Copy / Paste / Duplicate support.
- Drawings persist per symbol and survive page reloads.

------------------------------------------------------------
2.4 ORDER MANAGEMENT
------------------------------------------------------------
- Order types: Market, Limit, Stop
- Position sizing with three modes:
    * Fixed lots (quick presets: 0.01, 0.05, 0.1, 0.5, 1.0)
    * Risk % of account balance
    * Fixed monetary risk amount
- Risk analysis panel: risk amount, risk %, reward, R:R ratio,
  margin required, and commission.
- Take-profit and stop-loss, with visual drag-to-edit on the
  chart.
- One-click trading mode for instant market orders (with a
  confirmation toggle).
- Order confirmation dialog with a full trade summary before
  execution.
- Positions and pending orders can be modified, partially
  closed, or cancelled from the bottom panel.

------------------------------------------------------------
2.5 WATCHLIST
------------------------------------------------------------
- Live bid/ask prices for all instruments with correct pip
  digits.
- Search and filter by symbol name.
- Favorites (starred symbols) preserved across sessions.
- Category tabs (All, Favorites, and per-broker category).
- Quick one-click Buy/Sell buttons (in one-click mode).

------------------------------------------------------------
2.6 DEPTH OF MARKET (DOM)
------------------------------------------------------------
- 10-level bid/ask depth ladder around the current price.
- Visual volume bars for each price level.

------------------------------------------------------------
2.7 POSITIONS, ORDERS & HISTORY
------------------------------------------------------------
- Positions tab: view, modify SL/TP, close, or partially close
  open positions.
- Orders tab: view, modify, or cancel pending orders.
- History tab: review closed trades with realized profit/loss.
- Journal tab: trade activity log.
- News tab: market news feed.
- Economic Calendar: upcoming events.

------------------------------------------------------------
2.8 CHART TEMPLATES
------------------------------------------------------------
- Save and load complete chart configurations (indicators,
  plugins, settings).
- Auto-save option to persist changes automatically.
- Per-symbol template support.

------------------------------------------------------------
2.9 SESSION REPLAY
------------------------------------------------------------
- Replay historical sessions at adjustable speeds
  (0.5x, 1x, 2x, 5x, 10x).
- Date picker to select the session to replay.
- Play, pause, resume, and stop controls.

------------------------------------------------------------
2.10 DESKTOP APP
------------------------------------------------------------
- Standalone Windows application (installer and portable
  versions).
- Launches the MT5 bridge automatically.
- Trial mode (200-bar chart history) with license activation
  for full history.


============================================================
3. KEYBOARD SHORTCUTS
============================================================

All shortcuts are active within the chart area. They are
disabled when focus is on a text input, dropdown, or dialog.

------------------------------------------------------------
3.1 DRAWING TOOL SHORTCUTS
------------------------------------------------------------
  Alt + T        Activate the Trend Line tool
  Alt + H        Activate the Horizontal Line tool
  Alt + F        Activate the Fibonacci Retracement tool
  Alt + R        Activate the Rectangle tool
  Alt + M        Activate the Measure tool

------------------------------------------------------------
3.2 UNDO / REDO
------------------------------------------------------------
  Ctrl + Z       Undo the last drawing action
  Ctrl + Shift + Z   Redo
  Ctrl + Y       Redo (original alternative)

------------------------------------------------------------
3.3 CLIPBOARD & DUPLICATION
------------------------------------------------------------
  Ctrl + C       Copy selected drawing(s)
  Ctrl + V       Paste copied drawing(s)
  Ctrl + D       Duplicate selected drawing(s)

------------------------------------------------------------
3.4 NUDGING DRAWINGS
------------------------------------------------------------
  Arrow keys     Nudge the selected drawing by 1 pixel
  Shift + Arrow keys   Nudge the selected drawing by 10 pixels

------------------------------------------------------------
3.5 SELECTION & DELETION
------------------------------------------------------------
  Shift + Click  Multi-select drawings
  Delete / Backspace   Delete all selected drawings
  Escape         Cancel the current action, de-arm the active
                 tool, or deselect everything

------------------------------------------------------------
3.6 MODIFIER BEHAVIORS
------------------------------------------------------------
  Shift while placing/dragging   Snap to 45-degree angles
  Escape in any dialog           Close the dialog

------------------------------------------------------------
3.7 NAVIGATION
------------------------------------------------------------
  Enter / Space on a positions or orders row
                 Switch the chart to that symbol
  Escape in indicator settings    Close the popup
  Escape in chart context menu    Close the menu
  Enter in the license activation field
                 Submit activation

-----------------------------------------------------------
3.8 EXTRAZ
-----------------------------------------------------------
  Up/Down Arrow keys to circle through symbols in the
  watchlist
  F11  toggle Fullscreen

============================================================
4. BROKER COMPATIBILITY & SYMBOL SUPPORT
============================================================

FXAxis reads symbols, tick data, and candle history directly
from your MetaTrader 5 terminal. This means the instruments
available in the app are determined entirely by what your
broker provides in MT5.

------------------------------------------------------------
4.1 HOW SYMBOLS WORK
------------------------------------------------------------
- When FXAxis starts, it queries MT5 for all symbols available
  on your account and populates the watchlist automatically.
- Candle history, tick data, contract sizes, margins, and swap
  rates are all read per-symbol from MT5. FXAxis does not
  override or hard-code any of this information.
- The display name, pip digits, and category grouping for each
  symbol are derived from the MT5 symbol properties.

------------------------------------------------------------
4.2 COMPATIBILITY NOTES
------------------------------------------------------------
- Forex (majors, minors, exotics):
      Fully supported when your broker provides them in MT5.
- Metals (XAUUSD, XAGUSD, etc.):
      Supported. Contract sizes and margin calculations follow
      your broker's MT5 configuration.
- Indices, energies, and CFDs:
      Supported if your MT5 broker offers them. Symbol names
      may vary between brokers (for example, US30 vs
      WallStreet30 vs US30m). FXAxis displays whatever name
      MT5 reports.
- Cryptocurrencies:
      Supported where available through MT5. Symbol naming
      varies by broker (for example, BTCUSD vs BTCUSDm vs
      BTC/USD).
- Custom or exotic symbols:
      Most symbols work out of the box. If a symbol's data is
      malformed or its properties are missing from MT5, the
      watchlist shows "--" for that symbol's price until valid
      data arrives.

------------------------------------------------------------
4.3 IF A SYMBOL IS NOT DISPLAYING CORRECTLY
------------------------------------------------------------
If you notice that certain broker symbols are not fully
supported, are missing from the watchlist, show incorrect pip
digits, or have wrong pricing/contract information, please let
us know. We actively work to improve compatibility across
brokers.

To report a symbol issue, contact us:

  WhatsApp: +27 71 578 0602
  Website:  https://kalifxlab.com/FXAXIS/

When reporting, please include:
  1. Your broker name and account type (demo or live).
  2. The symbol name as it appears in your MT5 terminal.
  3. A screenshot or description of what is wrong (missing
     price, wrong digits, etc.).


============================================================
5. DESKTOP-APP LICENSING
============================================================

The desktop app ships with a free trial tier (200-bar chart
history) and can be unlocked to full history with a license key
generated for a specific machine.

- License keys are validated server-side so the master key
  never ships inside the app.
- To obtain a license key, open the "Activate" window inside
  FXAxis and click the WhatsApp link, or contact us directly
  (see Section 7 below).


============================================================
6. KNOWN LIMITATIONS
============================================================

- Requires a running, logged-in MT5 terminal on the same PC.
  FXAxis has no bundled or simulated data feed. If MT5 is
  closed or the broker connection drops, prices and trading
  pause until it reconnects.
- The depth-of-market (DOM) ladder uses simulated volume at
  each price level. Real order-book depth is not available
  through the MT5 Python API.
- The free trial tier limits chart history to 200 bars. A
  license key is required for full history depth.
- Windows only. The desktop app targets Windows (x64).


============================================================
7. CONTACT & SUPPORT
============================================================

We want FXAxis to work perfectly with your broker. If you run
into any issues -- symbol problems, connection errors, feature
requests, or general questions -- please reach out:

  WhatsApp: +27 71 578 0602
  Website:  https://kalifxlab.com/FXAXIS/

------------------------------------------------------------
7.1 WHAT TO INCLUDE WHEN CONTACTING US
------------------------------------------------------------
- Broker name and account type (demo or live)
- MT5 terminal build number (Help > About in MT5)
- FXAxis version (shown in the About dialog)
- Steps to reproduce the issue
- Screenshots, if applicable

------------------------------------------------------------
7.2 THINGS YOU CAN SPECIFICALLY REPORT
------------------------------------------------------------
- Broker symbols that are missing from the watchlist
- Symbols showing incorrect pricing, pip digits, or contract
  sizes
- Connection failures between FXAxis and MT5
- Order execution errors or unexpected behavior
- Features you would like to see added


