colyseus 0.15.7 → 0.15.9
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/LICENSE +2 -1
- package/README.md +17 -66
- package/package.json +5 -5
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
<a href="https://github.com/colyseus/colyseus">
|
|
3
|
-
<img src="media/
|
|
3
|
+
<img src="media/logo.svg?raw=true" width="60%" height="300" />
|
|
4
4
|
</a>
|
|
5
5
|
<br>
|
|
6
6
|
<br>
|
|
7
7
|
<a href="https://npmjs.com/package/colyseus">
|
|
8
8
|
<img src="https://img.shields.io/npm/dm/colyseus.svg?style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAQAAAC1+jfqAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QAAKqNIzIAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAHdElNRQfjAgETESWYxR33AAAAtElEQVQoz4WQMQrCQBRE38Z0QoTcwF4Qg1h4BO0sxGOk80iCtViksrIQRRBTewWxMI1mbELYjYu+4rPMDPtn12ChMT3gavb4US5Jym0tcBIta3oDHv4Gwmr7nC4QAxBrCdzM2q6XqUnm9m9r59h7Rc0n2pFv24k4ttGMUXW+sGELTJjSr7QDKuqLS6UKFChVWWuFkZw9Z2AAvAirKT+JTlppIRnd6XgaP4goefI2Shj++OnjB3tBmHYK8z9zAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDE5LTAyLTAxVDE4OjE3OjM3KzAxOjAwGQQixQAAACV0RVh0ZGF0ZTptb2RpZnkAMjAxOS0wMi0wMVQxODoxNzozNyswMTowMGhZmnkAAAAZdEVYdFNvZnR3YXJlAHd3dy5pbmtzY2FwZS5vcmeb7jwaAAAAAElFTkSuQmCC">
|
|
9
9
|
</a>
|
|
10
|
-
<a href="
|
|
10
|
+
<a href="https://github.com/colyseus/colyseus/discussions" title="Discuss on Forum">
|
|
11
11
|
<img src="https://img.shields.io/badge/discuss-on%20forum-brightgreen.svg?style=for-the-badge&colorB=0069b8&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAQAAAC1+jfqAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QAAKqNIzIAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAHdElNRQfjAgETDROxCNUzAAABB0lEQVQoz4WRvyvEARjGP193CnWRH+dHQmGwKZtFGcSmxHAL400GN95ktIpV2dzlLzDJgsGgGNRdDAzoQueS/PgY3HXHyT3T+/Y87/s89UANBKXBdoZo5J6L4K1K5ZxHfnjnlQUf3bKvkgy57a0r9hS3cXfMO1kWJMza++tj3Ac7/LY343x1NA9cNmYMwnSS/SP8JVFuSJmr44iFqvtmpjhmhBCrOOazCesq6H4P3bPBjFoIBydOk2bUA17I080Es+wSZ51B4DIA2zgjSpYcEe44Js01G0XjRcCU+y4ZMrDeLmfc9EnVd5M/o0VMeu6nJZxWJivLmhyw1WHTvrr2b4+2OFqra+ALwouTMDcqmjMAAAAldEVYdGRhdGU6Y3JlYXRlADIwMTktMDItMDFUMTg6MTM6MTkrMDE6MDAC9f6fAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDE5LTAyLTAxVDE4OjEzOjE5KzAxOjAwc6hGIwAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAAASUVORK5CYII=" alt="Discussion forum" />
|
|
12
12
|
</a>
|
|
13
|
-
<a href="
|
|
13
|
+
<a href="http://chat.colyseus.io">
|
|
14
14
|
<img src="https://img.shields.io/discord/525739117951320081.svg?style=for-the-badge&colorB=7581dc&logo=discord&logoColor=white">
|
|
15
15
|
</a>
|
|
16
16
|
<h3>
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
</div>
|
|
20
20
|
|
|
21
21
|
Colyseus is an Authoritative Multiplayer Framework for Node.js, with clients
|
|
22
|
-
available for the Web, Unity3d, Defold, Haxe, and
|
|
22
|
+
available for the Web, Unity3d, Defold, Haxe, and Cocos. ([See official clients](#%EF%B8%8F-official-client-integration))
|
|
23
23
|
|
|
24
24
|
The project focuses on providing synchronizable data structures for realtime and
|
|
25
25
|
turn-based games, matchmaking, and ease of usage both on the server-side and
|
|
@@ -28,80 +28,35 @@ client-side.
|
|
|
28
28
|
The mission of the framework is to be a standard netcode & matchmaking solution
|
|
29
29
|
for any kind of project you can think of!
|
|
30
30
|
|
|
31
|
-
|
|
32
|
-
it](https://discuss.colyseus.io/category/5/showcase) and make your own!
|
|
33
|
-
|
|
34
|
-
> ⭐️ Enjoying Colyseus? Show your support by starring the project on GitHub ⭐️
|
|
35
|
-
|
|
36
|
-
## What Colyseus provides to you:
|
|
31
|
+
## Key features:
|
|
37
32
|
|
|
38
33
|
- WebSocket-based communication
|
|
39
34
|
- Simple API in the server-side and client-side.
|
|
40
|
-
- Automatic state synchronization
|
|
41
|
-
- Matchmaking clients into game sessions
|
|
35
|
+
- Automatic state synchronization from server-to-client (delta compressed)
|
|
36
|
+
- Matchmaking clients into game rooms/sessions
|
|
42
37
|
- Scale vertically or horizontally
|
|
43
38
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
- Game Engine: Colyseus is agnostic of the engine you're using. Need Physics? Add your own logic / package.
|
|
47
|
-
- Database: It's up to you to configure and select which database you'd like to use.
|
|
48
|
-
|
|
49
|
-
See [roadmap](https://github.com/colyseus/colyseus/wiki/Roadmap) for our future plans.
|
|
39
|
+
See [public roadmap](https://github.com/colyseus/colyseus/wiki/Public-Roadmap) for future plans.
|
|
50
40
|
|
|
51
41
|
# 🚀 Quickstart
|
|
52
42
|
|
|
53
|
-
Create a bare-bones Colyseus server by using `npm
|
|
43
|
+
Create a bare-bones Colyseus server by using `npm create colyseus-app@latest`:
|
|
54
44
|
|
|
55
45
|
```
|
|
56
|
-
npm
|
|
46
|
+
npm create colyseus-app@latest my-colyseus-server
|
|
57
47
|
cd my-colyseus-server
|
|
58
48
|
npm start
|
|
59
49
|
```
|
|
60
|
-
# 🏟 Colyseus Arena: Fast & Scalable Cloud Hosting
|
|
61
|
-
|
|
62
|
-
- Looking for a fully managed solution for your Colyseus game server?
|
|
63
|
-
- Want to focus on game development and not on the hosting and infrastructure?
|
|
64
|
-
- Launching a production title and need a solution for 1,000 to 100,000+ CCUs?
|
|
65
|
-
|
|
66
|
-
If so [Colyseus Arena](https://www.colyseus.io/arena) cloud hosting is the solution you are looking for. Easily upload your existing Colyseus Server code and get started today for Free!
|
|
67
|
-
|
|
68
|
-
# 🕹️ Official Client Integration
|
|
69
50
|
|
|
70
|
-
|
|
71
|
-
- [Unity](https://github.com/colyseus/colyseus-unity3d) ([unity3d.com](https://unity3d.com/))
|
|
72
|
-
- [Defold Engine](https://github.com/colyseus/colyseus-defold) ([defold.com](https://www.defold.com/))
|
|
73
|
-
- [Haxe](https://github.com/colyseus/colyseus-hx) ([haxe.org](https://haxe.org/))
|
|
74
|
-
- [Construct 3](https://github.com/colyseus/colyseus-construct3) ([construct3.net](https://www.construct.net/))
|
|
75
|
-
- [Cocos2d-x](https://github.com/colyseus/colyseus-cocos2d-x) ([cocos2d-x.org](https://cocos2d-x.org/))
|
|
51
|
+
# Sponsors
|
|
76
52
|
|
|
77
|
-
|
|
53
|
+
The sustainability of the project relies on **Colyseus Cloud** subscriptions and sponsorships. If you are not using Colyseus Cloud, please consider [sponsoring the project](https://github.com/sponsors/endel) 💖
|
|
78
54
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
- [@colyseus/loadtest](https://github.com/colyseus/colyseus-loadtest) - Utility tool for load testing Colyseus
|
|
55
|
+
<a href="https://colyseus.io/sponsorkit/sponsors.svg">
|
|
56
|
+
<img src="https://github.com/colyseus/colyseus.github.io/blob/master/sponsorkit/sponsors.svg?raw=1" width="100%" />
|
|
57
|
+
</a>
|
|
83
58
|
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
- [colyseus-hxjs](https://github.com/serjek/colyseus-hxjs): Haxe externs for colyseus server (by [@serjek](https://github.com/serjek))
|
|
87
|
-
- [colyseus-kotlin](https://github.com/doorbash/colyseus-kotlin): Client for Java/Kotlin (by [@doorbash](https://github.com/doorbash))
|
|
88
|
-
- [Stencyl Extension](http://community.stencyl.com/index.php/topic,61150.0.html): [Stencyl](http://stencyl.com) extension to communicate with a Colyseus server (by [MdotEdot](http://www.stencyl.com/users/index/32424))
|
|
89
|
-
- [Colyseus-ObjC](https://github.com/swittk/Colyseus-ObjC): Client for Objective C (by [@swittk](https://github.com/swittk))
|
|
90
|
-
- [Colyseus-for-C2](https://github.com/Keevle/Colyseus-for-C2): Client for Construct 2 (by [@Keevle](https://github.com/Keevle))
|
|
91
|
-
|
|
92
|
-
# Usage examples
|
|
93
|
-
|
|
94
|
-
See the [official examples](https://github.com/colyseus/colyseus-examples) for
|
|
95
|
-
usage reference with the latest version of Colyseus.
|
|
96
|
-
|
|
97
|
-
- [Tech Demo: Shooting Gallery](https://github.com/colyseus/unity-demo-shooting-gallery) - Unity + Colyseus "Shooting Gallery" Tech Demo
|
|
98
|
-
- [Colyseus + PixiJS Boilerplate](https://colyseus-pixijs-boilerplate.herokuapp.com/) ([source-code](https://github.com/endel/colyseus-pixijs-boilerplate)) - Simplistic agar.io implementation using [PixiJS](https://github.com/pixijs/pixi.js)
|
|
99
|
-
- [Colyseus + BabylonJS Boilerplate](https://babylonjs-multiplayer.herokuapp.com/) ([source-code](https://github.com/endel/babylonjs-multiplayer-boilerplate)) - Bare-bones [BabylonJS](https://github.com/BabylonJS/Babylon.js) example
|
|
100
|
-
- [Tic Tac Toe](https://tictactoe-colyseus.herokuapp.com) ([source-code](https://github.com/endel/tic-tac-toe)) - Tic Tac Toe using [PixiJS](https://github.com/pixijs/pixi.js) and [Defold Engine](https://defold.com)
|
|
101
|
-
- [Collaborative Drawing Prototype](https://colyseus-drawing-prototype.herokuapp.com/) ([source-code](https://github.com/endel/colyseus-collaborative-drawing)) - Collaborative drawing using HTML5 canvas.
|
|
102
|
-
- (outdated: < v0.8.x): [tanx](https://playcanvas.com/project/367035/overview/tanxcolyseus), [react-example](https://github.com/endel/colyseus-react-example), [LD35 entry: dotower](http://ludumdare.com/compo/ludum-dare-35/?action=preview&uid=50958)
|
|
103
|
-
|
|
104
|
-
# Contributors
|
|
59
|
+
# Contributors ✨
|
|
105
60
|
|
|
106
61
|
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
|
|
107
62
|
|
|
@@ -120,7 +75,7 @@ Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds
|
|
|
120
75
|
</tr>
|
|
121
76
|
<tr>
|
|
122
77
|
<td align="center"><a href="https://github.com/enriqueto"><img src="https://avatars2.githubusercontent.com/u/5557196?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Enriqueto</b></sub></a><br /><a href="#business-enriqueto" title="Business development">💼</a></td>
|
|
123
|
-
<td align="center"><a href="https://github.com/fazriz"><img src="https://avatars0.githubusercontent.com/u/2628698?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Fazri Zubair</b></sub></a><br /><a href="#
|
|
78
|
+
<td align="center"><a href="https://github.com/fazriz"><img src="https://avatars0.githubusercontent.com/u/2628698?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Fazri Zubair</b></sub></a><br /><a href="#business-fazriz" title="Business development">💼</a></td>
|
|
124
79
|
<td align="center"><a href="https://twitter.com/Federkun"><img src="https://avatars2.githubusercontent.com/u/21344385?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Federico</b></sub></a><br /><a href="https://github.com/colyseus/colyseus/issues?q=author%3AFederkun" title="Bug reports">🐛</a> <a href="https://github.com/colyseus/colyseus/commits?author=Federkun" title="Code">💻</a></td>
|
|
125
80
|
<td align="center"><a href="https://github.com/mobyjames/"><img src="https://avatars0.githubusercontent.com/u/1327007?v=4?s=100" width="100px;" alt=""/><br /><sub><b>James Jacoby</b></sub></a><br /><a href="#question-mobyjames" title="Answering Questions">💬</a> <a href="#example-mobyjames" title="Examples">💡</a> <a href="#content-mobyjames" title="Content">🖋</a></td>
|
|
126
81
|
<td align="center"><a href="http://wenish.github.io/portfolio/"><img src="https://avatars0.githubusercontent.com/u/18367963?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jonas Voland</b></sub></a><br /><a href="#question-Wenish" title="Answering Questions">💬</a> <a href="https://github.com/colyseus/colyseus/issues?q=author%3AWenish" title="Bug reports">🐛</a> <a href="https://github.com/colyseus/colyseus/commits?author=Wenish" title="Code">💻</a> <a href="#ideas-Wenish" title="Ideas, Planning, & Feedback">🤔</a> <a href="#example-Wenish" title="Examples">💡</a></td>
|
|
@@ -154,10 +109,6 @@ guide](.github/CONTRIBUTING.md) for guidelines about how to proceed. Join us!
|
|
|
154
109
|
Everyone interacting in Colyseus and its sub-projects' codebases, issue trackers
|
|
155
110
|
and chat rooms is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
|
|
156
111
|
|
|
157
|
-
# Backers / Supporters via Patreon
|
|
158
|
-
|
|
159
|
-
As of February 2021, Colyseus is owned and sponsored by [Lucid Sight](https://www.lucidsight.com/). A warm **thank you** for previous supporters of the project is forever documented in the [early supporters wiki page](https://github.com/colyseus/colyseus/wiki/Early-supporters-(2017-2021)).
|
|
160
|
-
|
|
161
112
|
# License
|
|
162
113
|
|
|
163
114
|
MIT
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "colyseus",
|
|
3
|
-
"version": "0.15.
|
|
4
|
-
"description": "Multiplayer Framework for Node.js
|
|
3
|
+
"version": "0.15.9",
|
|
4
|
+
"description": "Multiplayer Framework for Node.js",
|
|
5
5
|
"input": "./src/index.ts",
|
|
6
6
|
"main": "./build/index.js",
|
|
7
7
|
"module": "./build/index.mjs",
|
|
8
8
|
"typings": "./build/index.d.ts",
|
|
9
9
|
"scripts": {
|
|
10
|
-
"test": "TS_NODE_PROJECT=../../tsconfig/tsconfig.test.json COLYSEUS_SEAT_RESERVATION_TIME=0.3 COLYSEUS_PRESENCE_SHORT_TIMEOUT=300 c8 mocha --require
|
|
10
|
+
"test": "TS_NODE_PROJECT=../../tsconfig/tsconfig.test.json COLYSEUS_SEAT_RESERVATION_TIME=0.3 COLYSEUS_PRESENCE_SHORT_TIMEOUT=300 c8 mocha --require tsx test/**.test.ts test/**/**.test.ts --exit --timeout 15000"
|
|
11
11
|
},
|
|
12
12
|
"author": "Endel Dreyer",
|
|
13
13
|
"license": "MIT",
|
|
@@ -31,10 +31,10 @@
|
|
|
31
31
|
"node": ">= 14.x"
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
|
-
"@colyseus/core": "^0.15.
|
|
34
|
+
"@colyseus/core": "^0.15.8",
|
|
35
35
|
"@colyseus/redis-driver": "^0.15.3",
|
|
36
36
|
"@colyseus/redis-presence": "^0.15.2",
|
|
37
37
|
"@colyseus/ws-transport": "^0.15.1"
|
|
38
38
|
},
|
|
39
|
-
"gitHead": "
|
|
39
|
+
"gitHead": "4116b09de63e20e8aac5d0c53e1f41ec68264dae"
|
|
40
40
|
}
|