chore: add README and fix misc in pong-network

Author: Exeloo

.github/logo.png

@@ -1,49 +1,73 @@
-# Engine
-
-This repository contains the full engine for NanoForge.
-It can be used by itself.
-
-The engine is made of multiple components:
-
-- [ecs-client](packages/ecs-client)
-- [ecs-server](packages/ecs-server)
-- [ecs-lib](packages/ecs-lib)
-- [input](packages/input)
-- [core](packages/core)
-- [common](packages/common)
-- [graphics-2d](packages/graphics-2d)
-- [asset-manager](packages/asset-manager)
-- [sound](packages/sound)
-- [music](packages/music)
-
-This is the full nanoforge engine including all the default libraries.
-
-In order to manage this project we use (pnpm)[https://pnpm.io/]
-
-## Installing dependencies
-
-To install dependencies run:
-
-```sh
-pnpm i
+<div align="center">
+	<br />
+	<p>
+		<a href="https://github.com/NanoForge-dev"><img src="https://github.com/NanoForge-dev/blob/main/.github/logo.png" width="546" alt="NanoForge" /></a>
+	</p>
+	<br />
+	<p>
+		<a href="https://github.com/NanoForge-dev/Engine/actions"><img src="https://github.com/NanoForge-dev/Engine/actions/workflows/tests.yml/badge.svg" alt="Tests status" /></a>
+		<a href="https://github.com/NanoForge-dev/Engine/commits/main"><img src="https://img.shields.io/github/last-commit/NanoForge-dev/Engine.svg?logo=github&logoColor=ffffff" alt="Last commit." /></a>
+		<a href="https://github.com/NanoForge-dev/Engine/graphs/contributors"><img src="https://img.shields.io/github/contributors/NanoForge-dev/Engine.svg?maxAge=3600&logo=github&logoColor=fff&color=00c7be" alt="contributors" /></a>
+	</p>
+</div>
+
+## About
+
+This repository contains multiple packages with separate [releases][github-releases]. Nanoforge is a powerful game engine for web browser.
+
+## Usage
+
+To use Nanoforge Engine, please refer to the [CLI documentation][cli-source] !
+
+First, install the CLI :
+```bash
+npm install -g @nanoforge-dev/cli
 ```
 
-## Building
-
-To build the project run:
-
-```sh
-pnpm build
+And then create a new project :
+```bash
+nf new
 ```
 
-## Tests
-
-To run tests use:
-
-```sh
-pnpm test
-```
-
-## Setting up a test project
-
-In order to setup a test project see (this)[https://github.com/NanoForge-dev/Engine/docs/Introduction.md]
+## Packages
+
+- `@nanoforge-dev/common` ([source][common-source]) - Common interfaces and utilities used by Nanoforge Engine
+- `@nanoforge-dev/core` ([source][core-source]) - A core package that contains game main loop
+- `@nanoforge-dev/ecs-lib` ([source][ecs-lib-source]) - A powerful data structure for managing game entities (*do not use this in your projects*)
+- `@nanoforge-dev/ecs-client` ([source][ecs-client-source]) - A wrapper of `@nanoforge-dev/ecs-lib` for client-side usage
+- `@nanoforge-dev/ecs-server` ([source][ecs-server-source]) - A wrapper of `@nanoforge-dev/ecs-lib` for server-side usage
+- `@nanoforge-dev/config` ([source][config-source]) - A wrapper of `class-validator` and `class-transformer` to imports validation and transformation decorators
+- `@nanoforge-dev/graphics-2d` ([source][graphics-2d-source]) - A base 2D graphics library
+- `@nanoforge-dev/asset-manager` ([source][asset-manager-source]) - A manager for loading assets to uniform workwith between client and server
+- `@nanoforge-dev/network-client` ([source][network-client-source]) - A network lib with tcp and udp support for client-side usage
+- `@nanoforge-dev/network-server` ([source][network-server-source]) - A network lib with tcp and udp support for server-side usage
+- `@nanoforge-dev/input` ([source][input-source]) - An input manager for handling keyboard and mouse events
+- `@nanoforge-dev/music` ([source][music-source]) - A music player for your game
+- `@nanoforge-dev/sound` ([source][sound-source]) - A sound manager for your game
+
+## Contributing
+
+Please read through our [contribution guidelines][contributing] before starting a pull request. We welcome contributions of all kinds, not just code! If you're stuck for ideas, look for the [good first issue][good-first-issue] label on issues in the repository. If you have any questions about the project, feel free to ask them on [Discussions][discussions]. Before creating your own issue or pull request, always check to see if one already exists! Don't rush contributions, take your time and ensure you're doing it correctly.
+
+## Help
+
+If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please ask on [Discussions][discussions].
+
+[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md
+[discussions]: https://github.com/NanoForge-dev/Engine/discussions
+[cli-source]: https://github.com/NanoForge-dev/CLI
+[github-releases]: https://github.com/NanoForge-dev/Engine/releases
+[asset-manager-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/asset-manager
+[common-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/common
+[config-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/config
+[core-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/core
+[ecs-client-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-client
+[ecs-lib-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-lib
+[ecs-server-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-server
+[graphics-2d-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/graphics-2d
+[input-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/input
+[music-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/music
+[network-client-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/network-client
+[network-server-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/network-server
+[sound-source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/sound
+[good-first-issue]: https://github.com/NanoForge-dev/Engine/contribute

README.md

@@ -78,7 +78,7 @@ export const main = async (options: IRunOptions) => {
 
     return new Promise((resolve) => {
       const check = () => {
-        if (network.udp?.isConnected()) {
+        if (network.udp.isConnected()) {
           resolve();
         } else {
           setTimeout(check, 50);
@@ -89,6 +89,6 @@ export const main = async (options: IRunOptions) => {
   }
 
   await waitForConnection();
-  network.tcp?.sendData(new TextEncoder().encode(JSON.stringify({ type: "play" })));
+  network.tcp.sendData(new TextEncoder().encode(JSON.stringify({ type: "play" })));
   app.run();
 };

example/pong-network/client/main.ts

@@ -31,14 +31,14 @@ export const controlPlayer = (registry: Registry, ctx: Context) => {
     const downPressed = input.isKeyPressed(Controller.down);
     if (upPressed == downPressed) {
       if (Controller.lastPressedUp || Controller.lastPressedDown) {
-        network.tcp?.sendData(
+        network.tcp.sendData(
           new TextEncoder().encode(JSON.stringify({ type: "input", key: "stop" })),
         );
         Controller.lastPressedDown = false;
         Controller.lastPressedUp = false;
       }
     } else if (upPressed && !Controller.lastPressedUp) {
-      network.tcp?.sendData(new TextEncoder().encode(JSON.stringify({ type: "input", key: "up" })));
+      network.tcp.sendData(new TextEncoder().encode(JSON.stringify({ type: "input", key: "up" })));
       Controller.lastPressedUp = true;
     } else if (downPressed && !Controller.lastPressedDown) {
       network.tcp?.sendData(
@@ -63,7 +63,7 @@ export function draw(registry: Registry) {
 
 export function packetHandler(registry: Registry, ctx: Context) {
   const network = ctx.libs.getNetwork<NetworkClientLibrary>();
-  const jsonPackets = network.tcp?.getReceivedPackets().map((packet) => {
+  const jsonPackets = network.tcp.getReceivedPackets().map((packet) => {
     return JSON.parse(new TextDecoder().decode(packet));
   });
 

example/pong-network/client/systems.ts

@@ -20,7 +20,6 @@ export function move(registry: Registry, ctx: Context) {
 }
 
 function sendMoveAll(id: number, vel: Velocity, pos: Position, network: NetworkServerLibrary) {
-  if (!network || !network.tcp) return;
   network.tcp.sendToEverybody(
     new TextEncoder().encode(
       JSON.stringify({
@@ -34,7 +33,6 @@ function sendMoveAll(id: number, vel: Velocity, pos: Position, network: NetworkS
 }
 
 function connectNewClient(newCli: number, network: NetworkServerLibrary, zip: any) {
-  if (!network || !network.tcp) return;
   network.tcp.sendToClient(
     newCli,
     new TextEncoder().encode(JSON.stringify({ type: "assignId", assigned: "ball", id: 0 })),
@@ -79,7 +77,7 @@ function handleClientInput(clientId: number, key: string, network: NetworkServer
 export function packetHandler(registry: Registry, ctx: Context) {
   const zip = registry.getZipper([Position, Velocity]);
   const network = ctx.libs.getNetwork<NetworkServerLibrary>();
-  if (!network || !network.tcp) return;
+
   if (network.tcp.getConnectedClients().indexOf(cli1) == -1) cli1 = -1;
   if (network.tcp.getConnectedClients().indexOf(cli2) == -1) cli2 = -1;
   const clientPackets = network.tcp.getReceivedPackets();

example/pong-network/server/systems.ts

@@ -1 +1,93 @@
-# Engine Network Client
+<div align="center">
+	<br />
+	<p>
+		<a href="https://github.com/NanoForge-dev"><img src="https://github.com/NanoForge-dev/blob/main/.github/logo.png" width="546" alt="NanoForge" /></a>
+	</p>
+	<br />
+	<p>
+		<a href="https://www.npmjs.com/package/@nanoforge-dev/network-client"><img src="https://img.shields.io/npm/v/@nanoforge-dev/network-client.svg?maxAge=3600" alt="npm version" /></a>
+		<a href="https://www.npmjs.com/package/@nanoforge-dev/network-client"><img src="https://img.shields.io/npm/dt/@nanoforge-dev/network-client.svg?maxAge=3600" alt="npm downloads" /></a>
+		<a href="https://github.com/NanoForge-dev/Engine/actions"><img src="https://github.com/NanoForge-dev/Engine/actions/workflows/tests.yml/badge.svg" alt="Tests status" /></a>
+		<a href="https://github.com/NanoForge-dev/Engine/commits/main/packages/network-client"><img src="https://img.shields.io/github/last-commit/NanoForge-dev/Engine.svg?logo=github&logoColor=ffffff&path=packages%2Fnetwork-client" alt="Last commit." /></a>
+	</p>
+</div>
+
+## About
+
+`@nanoforge-dev/network-client` is a network lib with tcp and udp support for client-side usage.
+
+## Installation
+
+**Node.js 24.11.0 or newer is required.**
+
+```sh
+npm install @nanoforge-dev/network-client
+yarn add @nanoforge-dev/network-client
+pnpm add @nanoforge-dev/network-client
+bun add @nanoforge-dev/network-client
+```
+
+## Example usage
+
+Initilize the library in your main file.
+```ts
+import { type IRunOptions } from "@nanoforge-dev/common";
+import { NanoforgeFactory } from "@nanoforge-dev/core";
+import { ECSClientLibrary } from "@nanoforge-dev/ecs-client";
+
+export function main(options: IRunClientOptions) {
+    const app = NanoforgeFactory.createClient();
+    
+    const network = new NetworkClientLibrary();
+    
+    app.useNetwork(network);
+    
+    app.init(options);
+    
+    app.run();
+}
+```
+
+Use to receive packets
+```ts
+export function myReceiveSystem(registry: Registry, ctx: Context) {
+    const network = ctx.libs.getNetwork<NetworkClientLibrary>();
+    
+    network.tcp.getReceivedPackets().forEach(packet => {
+        const data = JSON.parse(new TextDecoder().decode(packet));
+        // Do something with the data
+    });
+}
+```
+
+Use to send packets
+```ts
+export function mySendSystem(registry: Registry, ctx: Context) {
+    const network = ctx.libs.getNetwork<NetworkClientLibrary>();
+    
+    // Do something to get a data
+    const packet = new TextEncoder().encode(JSON.stringify(data));
+    network.tcp.sendPacket(packet);
+}
+```
+
+## Links
+
+- [GitHub][source]
+- [npm][npm]
+
+## Contributing
+
+Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
+[documentation][documentation].  
+See [the contribution guide][contributing] if you'd like to submit a PR.
+
+## Help
+
+If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions].
+
+[documentation]: https://github.com/NanoForge-dev/Engine
+[discussions]: https://github.com/NanoForge-dev/Engine/discussions
+[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/network-client
+[npm]: https://www.npmjs.com/package/@nanoforge-dev/network-client
+[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md

packages/network-client/README.md

@@ -1,25 +1,95 @@
-# Engine Network Manager
+<div align="center">
+	<br />
+	<p>
+		<a href="https://github.com/NanoForge-dev"><img src="https://github.com/NanoForge-dev/blob/main/.github/logo.png" width="546" alt="NanoForge" /></a>
+	</p>
+	<br />
+	<p>
+		<a href="https://www.npmjs.com/package/@nanoforge-dev/network-server"><img src="https://img.shields.io/npm/v/@nanoforge-dev/network-server.svg?maxAge=3600" alt="npm version" /></a>
+		<a href="https://www.npmjs.com/package/@nanoforge-dev/network-server"><img src="https://img.shields.io/npm/dt/@nanoforge-dev/network-server.svg?maxAge=3600" alt="npm downloads" /></a>
+		<a href="https://github.com/NanoForge-dev/Engine/actions"><img src="https://github.com/NanoForge-dev/Engine/actions/workflows/tests.yml/badge.svg" alt="Tests status" /></a>
+		<a href="https://github.com/NanoForge-dev/Engine/commits/main/packages/network-server"><img src="https://img.shields.io/github/last-commit/NanoForge-dev/Engine.svg?logo=github&logoColor=ffffff&path=packages%2Fnetwork-server" alt="Last commit." /></a>
+	</p>
+</div>
 
-## Installing dependencies
+## About
 
-To install dependencies run:
+`@nanoforge-dev/network-server` is a network lib with tcp and udp support for server-side usage.
+
+## Installation
+
+**Node.js 24.11.0 or newer is required.**
 
 ```sh
-pnpm i
+npm install @nanoforge-dev/network-server
+yarn add @nanoforge-dev/network-server
+pnpm add @nanoforge-dev/network-server
+bun add @nanoforge-dev/network-server
 ```
 
-## Building
+## Example usage
 
-To build the project run:
+Initilize the library in your main file.
+```ts
+import { type IRunOptions } from "@nanoforge-dev/common";
+import { NanoforgeFactory } from "@nanoforge-dev/core";
+import { ECSServerLibrary } from "@nanoforge-dev/ecs-server";
 
-```sh
-pnpm build
+export function main(options: IRunServerOptions) {
+    const app = NanoforgeFactory.createServer();
+    
+    const network = new NetworkServerLibrary();
+    
+    app.useNetwork(network);
+    
+    app.init(options);
+    
+    app.run();
+}
 ```
 
-## Tests
-
-To run tests use:
+Use to receive packets
+```ts
+export function myReceiveSystem(registry: Registry, ctx: Context) {
+    const network = ctx.libs.getNetwork<NetworkServerLibrary>();
+    
+    network.tcp.getReceivedPackets().forEach((packets, client) => {
+        packets.forEach((packet) => {
+            const data = JSON.parse(new TextDecoder().decode(packet));
+            // Do something with the data
+        });
+    });
+}
+```
 
-```sh
-pnpm test
+Use to send packets to everyones
+```ts
+export function mySendSystem(registry: Registry, ctx: Context) {
+    const network = ctx.libs.getNetwork<NetworkServerLibrary>();
+    
+    // Do something to get a data
+    const packet = new TextEncoder().encode(JSON.stringify(data));
+    network.tcp.sendToEverybody(packet);
+}
 ```
+
+## Links
+
+- [GitHub][source]
+- [npm][npm]
+
+## Contributing
+
+Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
+[documentation][documentation].  
+See [the contribution guide][contributing] if you'd like to submit a PR.
+
+## Help
+
+If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions].
+
+[documentation]: https://github.com/NanoForge-dev/Engine
+[discussions]: https://github.com/NanoForge-dev/Engine/discussions
+[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/network-server
+[npm]: https://www.npmjs.com/package/@nanoforge-dev/network-server
+[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md