@lzpenguin/server 1.1.8 → 1.1.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.
Files changed (2) hide show
  1. package/README.md +15 -5
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -23,8 +23,8 @@ const server = new RiffleServer({
23
23
  // 1. 监听数据推送(init 成功后每 0.2 秒自动推送,调用 init/update 后立即推送)
24
24
  server.onData((data) => {
25
25
  console.log('World:', data.world); // 世界数据
26
- console.log('Self:', data.self); // 自己的公开数据
27
- console.log('Players:', data.players); // 其他玩家的公开数据
26
+ console.log('Self:', data.self); // 自己的公开数据(包含 name 字段)
27
+ console.log('Players:', data.players); // 其他玩家的公开数据(包含 name 字段)
28
28
  // 注意:self 和 players[i] 结构相同,都只包含公开数据
29
29
  });
30
30
 
@@ -32,7 +32,8 @@ server.onData((data) => {
32
32
  server.init({
33
33
  world: { score: 0, level: 1 },
34
34
  self: {
35
- public: { name: 'Player1', x: 100, y: 100 }
35
+ public: { x: 100, y: 100 }
36
+ // name 字段不需要设置,服务器返回数据会包含
36
37
  }
37
38
  });
38
39
 
@@ -58,6 +59,10 @@ server.update({
58
59
  }
59
60
  ```
60
61
 
62
+ **关于 name 字段:**
63
+ - `self.name` 和 `players[i].name` 字段**一定会存在**,包含用户的昵称或用户名
64
+ - 你不需要在 `init()` 或 `update()` 时设置 name 字段,服务器会直接返回
65
+
61
66
  ## API 说明
62
67
 
63
68
  ### init(data) - 初始化服务器
@@ -68,7 +73,8 @@ server.update({
68
73
  server.init({
69
74
  world: { score: 0, level: 1 }, // 可选:世界初始数据
70
75
  self: {
71
- public: { name: 'Player1', x: 100, y: 100 } // 可选:玩家公开数据
76
+ public: { x: 100, y: 100 } // 可选:玩家公开数据
77
+ // 注意:name 字段不需要设置,服务器返回的数据会包含该字段
72
78
  }
73
79
  });
74
80
  ```
@@ -125,6 +131,9 @@ const server = new RiffleServer({
125
131
 
126
132
  // 监听推送
127
133
  server.onData((data) => {
134
+ // data.self.name 和 data.players[i].name 一定会存在
135
+ console.log('我的名字:', data.self.name);
136
+
128
137
  const myPosition = { x: data.self.x, y: data.self.y };
129
138
  const otherPlayers = data.players || [];
130
139
  renderPlayers(myPosition, otherPlayers);
@@ -137,7 +146,8 @@ server.onData((data) => {
137
146
  // 初始化
138
147
  server.init({
139
148
  world: { score: 0, level: 1 },
140
- self: { public: { name: 'Player1', x: 0, y: 0 } }
149
+ self: { public: { x: 0, y: 0 } }
150
+ // name 字段不需要设置,返回的数据会包含
141
151
  });
142
152
 
143
153
  // 更新玩家位置
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lzpenguin/server",
3
- "version": "1.1.8",
3
+ "version": "1.1.9",
4
4
  "description": "Riffle 游戏服务器 WebSocket 客户端 SDK",
5
5
  "license": "ISC",
6
6
  "author": "lzpenguin",