----------------------------------------------------------------------------
openMSX - the MSX emulator that aims for perfection
----------------------------------------------------------------------------

This is a FORK of the original openMSX project.

Original Project:
    https://github.com/openMSX/openMSX
    https://openmsx.org/

----------------------------------------------------------------------------
Fork Additions
----------------------------------------------------------------------------

This fork adds the following features:

* Debug HTTP Server (Pull-based)
  - Real-time debugging information via HTTP endpoints
  - Machine info, CPU registers, I/O status, memory dumps
  - Server-Sent Events (SSE) streaming support
  - Configurable ports (default: 65501-65504)

  How to enable:
    1. Launch openMSX
    2. Open the TCL console (press F10 or use the menu)
    3. Enter the following command:
       set debug_http_enable on
    4. Access the dashboards in your web browser:
       - http://127.0.0.1:65501/  (Machine info)
       - http://127.0.0.1:65502/  (I/O status)
       - http://127.0.0.1:65503/  (CPU registers)
       - http://127.0.0.1:65504/  (Memory viewer)

* Debug Stream Server (Push-based)
  - Real-time JSON Lines debug streaming via Telnet protocol
  - Push-based streaming for continuous state updates
  - OUTPUT_SPEC_V01 format with "emu":"msx" identifier
  - Default port: 65505

  How to enable:
    1. Launch openMSX
    2. Open the TCL console (press F10 or use the menu)
    3. Enter the following command:
       set debug_stream_enable on
    4. Connect via telnet or netcat:
       telnet 127.0.0.1 65505
       # or
       nc 127.0.0.1 65505

  Output format (JSON Lines):
    {"emu":"msx","cat":"cpu","sec":"reg","fld":"af","val":"F3A0","ts":...}
    {"emu":"msx","cat":"cpu","sec":"reg","fld":"pc","val":"0000","ts":...}

  Categories:
    - sys  : System messages (connection hello/goodbye)
    - mach : Machine info (id, name, type, status)
    - cpu  : CPU state (registers, flags, interrupts)
    - mem  : Memory access (read/write events, slot mapping)
    - dbg  : Debug events (breakpoint hits, trace)

  See src/debugger/README.md for detailed API documentation.

  See HOWTO_COMPILE.md for detailed usage instructions.

----------------------------------------------------------------------------
Documentation
----------------------------------------------------------------------------

openMSX comes with a set of HTML manuals that tell what you need to know
to install, configure and run openMSX. You can find these manuals in the
directory 'manual' inside the directory 'doc'. You can read them using
a web browser.

Additional documentation in this fork:
    HOWTO_COMPILE.md  - Build instructions (Korean)
    ANALYZE_PROJECT.md - Project structure analysis
    PLAN_MODIFY.md    - Modification plans

You can read what has changed in this and the previous releases in the
release notes. You can find the release notes of this release in the file
'release-notes.txt' in the directory 'doc'. Highlights of previous releases
can be found in 'release-history.txt'.

----------------------------------------------------------------------------
Copyright and License
----------------------------------------------------------------------------

All source code and other works that are part of, or distributed with
openMSX are copyrighted by their respective authors. The file 'authors.txt'
contains a list of people who made works for openMSX or contributed works
to openMSX.

Some source files contain a license notice; all other source files are
licensed under the GNU Public License (GPL), of which you can find a copy
in the file 'GPL.txt'. If you got a binary release of openMSX and are
interested in the sources, please visit the home page:
    https://openmsx.org/

Happy MSX-ing!
                        the openMSX developers

----------------------------------------------------------------------------