@utsp/runtime-server 0.17.3 → 0.17.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,36 +1,58 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
1
3
|
# @utsp/runtime-server
|
|
2
4
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
> This package is currently in early development and should **NOT** be used in production.
|
|
6
|
-
> The API is unstable and subject to breaking changes without notice.
|
|
5
|
+
[](https://www.npmjs.com/package/@utsp/runtime-server)
|
|
6
|
+
[](https://opensource.org/licenses/MIT)
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
Visit [**UTSP.dev**](https://utsp.dev/) for more information.
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
</div>
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
The **Server-side runtime** for the [Universal Text Stream Protocol](https://utsp.dev/) (UTSP). Built on Node.js, it manages the simulation logic and streams the state to multiple clients using a highly optimized binary protocol.
|
|
11
15
|
|
|
12
|
-
|
|
16
|
+
> [!WARNING]
|
|
17
|
+
> **PROTOTYPE - NOT READY FOR PRODUCTION**
|
|
18
|
+
> This package is under active development. The API is unstable and subject to breaking changes.
|
|
13
19
|
|
|
14
|
-
|
|
20
|
+
> [!NOTE]
|
|
21
|
+
> **Source Code Availability**
|
|
22
|
+
> While this package is licensed under MIT, the source code is currently being finalized for public release. It will be available on GitHub in the coming months.
|
|
15
23
|
|
|
16
|
-
|
|
17
|
-
- ❌ No documentation available yet
|
|
18
|
-
- ❌ Breaking changes expected
|
|
19
|
-
- ❌ Not recommended for production use
|
|
24
|
+
## ✨ Features
|
|
20
25
|
|
|
21
|
-
|
|
26
|
+
- **🚀 Node.js Runtime**: Headless orchestrator for server-side execution.
|
|
27
|
+
- **👥 Multi-user Support**: Persistent management of multiple user sessions.
|
|
28
|
+
- **📡 Server Authority**: Centralized simulation ensuring perfect state consistency.
|
|
29
|
+
- **🔗 Hybrid Networking**: Native support for Socket.IO and WebRTC.
|
|
22
30
|
|
|
23
|
-
## Installation
|
|
31
|
+
## 📦 Installation
|
|
24
32
|
|
|
25
33
|
```bash
|
|
26
34
|
npm install @utsp/runtime-server
|
|
27
35
|
```
|
|
28
36
|
|
|
29
|
-
##
|
|
37
|
+
## 🚀 Quick Start
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
import { ServerRuntime } from '@utsp/runtime-server';
|
|
41
|
+
import { MyGame } from './MyGame';
|
|
42
|
+
|
|
43
|
+
const runtime = new ServerRuntime({
|
|
44
|
+
application: new MyGame(),
|
|
45
|
+
tickRate: 60,
|
|
46
|
+
port: 3000
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
await runtime.start();
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## 📖 Documentation
|
|
30
53
|
|
|
31
|
-
|
|
32
|
-
- [Issues](https://github.com/thp-software/utsp/issues)
|
|
54
|
+
For detailed guides on the protocol and application development, visit the official [**Documentation**](https://docs.utsp.dev/introduction).
|
|
33
55
|
|
|
34
|
-
## License
|
|
56
|
+
## 📄 License
|
|
35
57
|
|
|
36
|
-
MIT ©
|
|
58
|
+
MIT © 2026 [THP Software](https://github.com/thp-software)
|