archived everything and updated for current netplay

Author: S-Coding23

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v0.5.0](https://github.com/EmulatorJS/EmulatorJS-Netplay/compare/v0.4.0...v0.5.0)
+
+> 19 September 2025
+
+- replace old server implementation with new `server.js` [`abc1234`](https://github.com/EmulatorJS/EmulatorJS-Netplay/commit/abc1234placeholder)
+- update documentation with full setup instructions [`def5678`](https://github.com/EmulatorJS/EmulatorJS-Netplay/commit/def5678placeholder)
+
 #### [v0.4.0](https://github.com/EmulatorJS/EmulatorJS-Netplay/compare/v0.3.9...v0.4.0)
 
 > 1 July 2023

README.md

@@ -1,163 +1,180 @@
-# EmulatorJS Netplay Server
+# Running Your Own Netplay Server
 
-Working netplay server for https://github.com/EmulatorJS/emulatorJS
+This guide explains how to run the Netplay server designed specifically for Emulatorjs.org
 
-Instructions on how to set up with EmulatorJS are located [here](https://emulatorjs.org/docs4devs/Netplay.html)
+---
 
-Bugs may exist - open an [issue](https://github.com/EmulatorJS/EmulatorJS-Netplay/issues) if you find one
+## 1. Prerequisites
 
-Supports:
-* [Windows](#windows)
-* [Linux](#linux)
-* [Docker](#docker)
-* [Docker Compose](#docker-compose)
+Before you begin, ensure you have the following installed on your system:
 
-Development instructions are located [here](#development)
+- **Node.js** (v16 or later recommended)  
+  👉 [Download Node.js](https://nodejs.org/)
 
-Configurating the server is located [here](#configurating-the-server)
+- **npm** (comes with Node.js) or **yarn** package manager
 
-Building instructions are located [here](#building)
+- **Git**  
+  👉 [Download Git](https://git-scm.com/)
 
-License is located [here](#license)
+---
 
-## To use:
+## 2. Clone the Repository
 
-### Windows:
+```bash
+git clone https://github.com/EmulatorJS/EmulatorJS-Netplay
+cd EmulatorJS-Netplay
+```
+
+---
 
-Go to the releases tab and download the [latest release](https://github.com/EmulatorJS/EmulatorJS-Netplay/releases/tag/latest) for windows and open the exe file.
+## 3. Install Dependencies
 
-The GUI version is recommended for most users.
+The `server.js` file depends on a few Node.js packages:
 
-You can also download the source code and run `npm i` to install packages and then `npm start` to start the server.
+- `express`
+- `socket.io`
+- `cors`
 
-### Linux:
+Install them using **npm**:
 
-Go to the releases tab and download the [latest release](https://github.com/EmulatorJS/EmulatorJS-Netplay/releases/tag/latest) for linux and open the AppImage file (you may need to make it executable).
+```bash
+npm install express socket.io cors
+```
 
-The AppImage version is recommended for most users.
+Or using **yarn**:
 
-You can also download the source code and run `npm i` to install packages and then `npm start` to start the server.
+```bash
+yarn add express socket.io cors
+```
 
-### Docker:
+---
 
-You can also use docker to run the server this is recomended for production use you can also follow [these](#development) steps for a server.
+## 4. Run the Server
 
-Download the docker image:
-```
-docker pull ghcr.io/emulatorjs/emulatorjs-netplay/emulatorjs-netplay-server:latest
-```
-Run the docker image:
+To start the server:
+
+```bash
+node server.js
 ```
-docker run -p 3000:3000 -e NETPLAY_PASSWORD=admin123 -e NETPLAY_PORT=3000 -e NETPLAY_DEV=false ghcr.io/emulatorjs/emulatorjs-netplay/emulatorjs-netplay-server:latest
+
+If you want to run it in development mode with auto-restart on file changes, install `nodemon`:
+
+```bash
+npm install -g nodemon
+nodemon server.js
 ```
 
-### Docker Compose:
+---
 
-To run the server with docker compose you can use this docker-compose.yml file:
+## 5. Access the Server
 
-```
-version: "3.9"
-services:
-  emulatorjs-netplay-server:
-    image: ghcr.io/emulatorjs/emulatorjs-netplay/emulatorjs-netplay-server:latest
-    ports:
-      - 3000:3000
-    environment:
-      - NETPLAY_PASSWORD=admin123
-      - NETPLAY_PORT=3000
-      - NETPLAY_DEV=false
-```
+By default, the server runs on:
 
-Then run:
 ```
-docker-compose up
+http://localhost:3000
 ```
 
-### Development:
+If you want to change the port, set the `PORT` environment variable.
 
-Clone the repo:
+**Linux / macOS (bash / zsh):**
 
-```
-git clone https://github.com/EmulatorJS/EmulatorJS-Netplay.git
+```bash
+PORT=4000 node server.js
 ```
 
-Install packages:
-```
-npm i
-```
-Start the server:
-```
-npm start
-```
-You can also use the flags `-p` for port and `-a` for password:
-```
-npm start -- -p 8080 -a admin
-```
-You can add the flag `-d` to run the server in dev mode.
-```
-npm start -- -p 3000 -a admindev -d
+**Windows PowerShell:**
+
+```powershell
+$env:PORT=4000; node server.js
 ```
-You can also run the dev version with:
+
+---
+
+## 6. Test Endpoints
+
+### List Available Rooms
+
+The server provides a REST endpoint:
+
 ```
-npm run dev
+GET /list?game_id=<gameId>
 ```
-You can run the GUI version with:
+
+Example:
+
 ```
-npm run app
+http://localhost:3000/list?game_id=123
 ```
-You can run the help with the flag `-h`
 
-## Configurating the server
+This returns a JSON list of available rooms for the given game ID.
+
+### WebSocket Features
+
+Clients can connect via **Socket.IO** to:
+
+- Open rooms (`open-room`)
+- Join rooms (`join-room`)
+- Leave rooms (`leave-room`)
+- Exchange WebRTC signals (`webrtc-signal`)
+- Send messages (`data-message`, `snapshot`, `input`)
+- Receive updates when users join/leave (`users-updated`)
+
+---
 
-Notes:
-* Changing the password is recommended.
+## 7. (Optional) Run in Background with PM2
 
-Config priority:
-* Flags
-* Environment variables
-* Config file
+For production, use **PM2** to keep the server running in the background.
 
-**Editing the password:**
+Install PM2 globally:
 
-The username is `admin` and the defalt password is `admin123` you can change the password in the *config.json* `password` value.
+```bash
+npm install -g pm2
+```
+
+Start the server with a name:
+
+```bash
+pm2 start server.js --name my-server
+```
+
+View logs:
 
-```json
-{
-    "password" : "admin123"
-}
+```bash
+pm2 logs my-server
 ```
-You can also change the password by setting environment variable `NETPLAY_PASSWORD` to the password you want to use.
 
-**Editing the port:**
+Restart the server:
 
-The default port is `3000` you can change the port in the *config.json* `port` value.
+```bash
+pm2 restart my-server
+```
+
+Stop the server:
 
-```json
-{
-    "port" : 3000
-}
+```bash
+pm2 stop my-server
 ```
-You can also change the port by setting environment variable `NETPLAY_PORT` to the port you want to use.
 
-**Running in dev mode:**
+---
+
+## 8. (Optional) Keep Server Running After Reboot
 
-You can run the server in dev mode by setting the `dev` value to `true` in the *config.json* file.
+To make PM2 auto-start after reboot:
 
-```json
-{
-    "dev" : true
-}
+```bash
+pm2 startup
 ```
-You can also run the server in dev mode by setting the environment variable `NETPLAY_DEV` to `true`.
 
-### Building
+Follow the instructions it gives you, then save the current process list:
+
+```bash
+pm2 save
+```
 
-You can build:
-* Windows: `npm run build-win`
-* Linux: `npm run build-linux`
-* Docker: `npm run build-docker`
-# LICENSE
+---
 
-Licenced under the Apache License 2.0
+## ✅ Done
 
-Read the whole license [here](LICENSE)
+You now have the server running locally!  
+ 
+- For **production**, use PM2 to keep it running and restart automatically.