===========================================================
               NetplayConnector — README
===========================================================

NetplayConnector is a small set of programs that makes it
easy to join RetroArch lobbies directly from your browser.

When you click a join link on:
    https://remz.ca/lobby
the programs will automatically launch RetroArch with the
correct game and core. No manual copy-paste needed!

-----------------------------------------------------------
 HOW TO USE
-----------------------------------------------------------

1. Place all files in the same folder as your RetroArch.exe
   Example folder layout:
       /RetroArch/
         ├── retroarch.exe
         ├── remz-listener.exe
         ├── retroarch-launcher.exe
         ├── launcher-config.json
         ├── QUICKSTART.txt
         ├── README.txt
         ├── /cores
         └── /games (subfolders allowed)

   - **Cores:** keep core files inside the /cores folder.
   - **Games:** keep ROMs inside the /games folder.
     You may organize them into subfolders (e.g. /games/NES,
     /games/SNES, /games/Arcade). Subfolders are supported.

2. Double-click remz-listener.exe (the .exe file with an icon)
   - It will start quietly in the background.
   - You’ll see a small tray icon near your clock.

3. Leave RemzListener running.
   - When you click a join link on https://remz.ca/lobby,
     it will automatically launch RetroArch with the
     correct game and core.

4. Tray icon menu:
   - Right-click → "View Logs" (see activity details)
   - Right-click → "Exit" (close the listener)

-----------------------------------------------------------
 FILES INCLUDED
-----------------------------------------------------------

- remz-listener.exe      → The listener program
- retroarch-launcher.exe → The launcher used by RemzListener
- launcher-config.json   → Configuration file
- QUICKSTART.txt         → Quick reference guide
- README.txt             → This detailed guide

-----------------------------------------------------------
 CONFIGURATION
-----------------------------------------------------------

- The default paths assume:
    /cores   → for RetroArch cores
    /games   → for your ROMs and games

- If you prefer a different folder layout, you can edit
  launcher-config.json to change these paths. For example:
    "coresPath": "D:/RetroArch/cores"
    "gamesPath": "E:/MyGames"

-----------------------------------------------------------
 NOTES
-----------------------------------------------------------

- Keep all files together with retroarch.exe.
- RemzListener must be running before clicking join links.
- A log file (launcher-log.txt) will be created in the
  same folder to help with troubleshooting.
- For future updates and downloadable content, visit:
    https://remz.ca/lobby/dlc

-----------------------------------------------------------
 ADMIN MODE
-----------------------------------------------------------

The Netplay Hub supports an Admin Mode for lobby management.

- Admin Mode is activated through the web interface:
    https://remz.ca/lobby

- To enable Admin Mode:
    1. Click "Set Admin Mode" in the lobby page.
    2. Enter the your administrator password.
    3. Once authenticated, you will see "Admin mode activated."

- What Admin Mode allows:
    - Submit new lobbies directly.
    - Manage existing lobbies (edit or remove).
    - Access additional admin-only features as they are added.

Notes:
- Admin Mode requires a valid administrator password.

-----------------------------------------------------------
 CREDITS
-----------------------------------------------------------

The netplay Hub was designed with care to make joining
RetroArch lobbies seamless, safe, and user-friendly.

===========================================================
© 2025 Remz Domain
===========================================================
