cyberia 3.1.3 → 3.2.5

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 (208) hide show
  1. package/.env.example +0 -2
  2. package/.github/workflows/engine-cyberia.cd.yml +10 -8
  3. package/.github/workflows/engine-cyberia.ci.yml +12 -29
  4. package/.github/workflows/ghpkg.ci.yml +4 -4
  5. package/.github/workflows/npmpkg.ci.yml +28 -11
  6. package/.github/workflows/publish.ci.yml +21 -2
  7. package/.github/workflows/pwa-microservices-template-page.cd.yml +4 -5
  8. package/.github/workflows/pwa-microservices-template-test.ci.yml +3 -3
  9. package/.github/workflows/release.cd.yml +13 -8
  10. package/CHANGELOG.md +433 -1
  11. package/CLI-HELP.md +57 -7
  12. package/Dockerfile +4 -2
  13. package/README.md +347 -22
  14. package/bin/build.js +5 -2
  15. package/bin/cyberia.js +1789 -112
  16. package/bin/deploy.js +177 -124
  17. package/bin/file.js +3 -0
  18. package/bin/index.js +1789 -112
  19. package/conf.js +64 -8
  20. package/deployment.yaml +92 -20
  21. package/hardhat/hardhat.config.js +13 -13
  22. package/hardhat/ignition/modules/ObjectLayerToken.js +1 -1
  23. package/hardhat/package-lock.json +2554 -5859
  24. package/hardhat/package.json +13 -22
  25. package/hardhat/scripts/deployObjectLayerToken.js +1 -1
  26. package/hardhat/test/ObjectLayerToken.js +4 -2
  27. package/hardhat/types/ethers-contracts/ObjectLayerToken.ts +690 -0
  28. package/hardhat/types/ethers-contracts/common.ts +92 -0
  29. package/hardhat/types/ethers-contracts/factories/ObjectLayerToken__factory.ts +1055 -0
  30. package/hardhat/types/ethers-contracts/factories/index.ts +4 -0
  31. package/hardhat/types/ethers-contracts/hardhat.d.ts +47 -0
  32. package/hardhat/types/ethers-contracts/index.ts +6 -0
  33. package/jsdoc.dd-cyberia.json +64 -55
  34. package/jsdoc.json +64 -55
  35. package/manifests/cronjobs/dd-cron/dd-cron-backup.yaml +5 -4
  36. package/manifests/cronjobs/dd-cron/dd-cron-dns.yaml +5 -4
  37. package/manifests/deployment/dd-cyberia-development/deployment.yaml +92 -20
  38. package/manifests/deployment/dd-cyberia-development/proxy.yaml +54 -18
  39. package/manifests/deployment/dd-default-development/deployment.yaml +2 -2
  40. package/manifests/deployment/dd-test-development/deployment.yaml +88 -74
  41. package/manifests/deployment/dd-test-development/proxy.yaml +13 -4
  42. package/manifests/deployment/playwright/deployment.yaml +1 -1
  43. package/nodemon.json +1 -1
  44. package/package.json +22 -16
  45. package/proxy.yaml +54 -18
  46. package/scripts/rhel-grpc-setup.sh +56 -0
  47. package/src/api/atlas-sprite-sheet/atlas-sprite-sheet.controller.js +44 -0
  48. package/src/api/atlas-sprite-sheet/atlas-sprite-sheet.model.js +16 -0
  49. package/src/api/atlas-sprite-sheet/atlas-sprite-sheet.router.js +5 -0
  50. package/src/api/atlas-sprite-sheet/atlas-sprite-sheet.service.js +80 -7
  51. package/src/api/cyberia-dialogue/cyberia-dialogue.controller.js +93 -0
  52. package/src/api/cyberia-dialogue/cyberia-dialogue.model.js +36 -0
  53. package/src/api/cyberia-dialogue/cyberia-dialogue.router.js +29 -0
  54. package/src/api/cyberia-dialogue/cyberia-dialogue.service.js +51 -0
  55. package/src/api/cyberia-entity/cyberia-entity.controller.js +74 -0
  56. package/src/api/cyberia-entity/cyberia-entity.model.js +24 -0
  57. package/src/api/cyberia-entity/cyberia-entity.router.js +27 -0
  58. package/src/api/cyberia-entity/cyberia-entity.service.js +42 -0
  59. package/src/api/cyberia-instance/cyberia-fallback-world.js +368 -0
  60. package/src/api/cyberia-instance/cyberia-instance.controller.js +92 -0
  61. package/src/api/cyberia-instance/cyberia-instance.model.js +84 -0
  62. package/src/api/cyberia-instance/cyberia-instance.router.js +63 -0
  63. package/src/api/cyberia-instance/cyberia-instance.service.js +191 -0
  64. package/src/api/cyberia-instance/cyberia-portal-connector.js +486 -0
  65. package/src/api/cyberia-instance-conf/cyberia-instance-conf.controller.js +74 -0
  66. package/src/api/cyberia-instance-conf/cyberia-instance-conf.defaults.js +413 -0
  67. package/src/api/cyberia-instance-conf/cyberia-instance-conf.model.js +228 -0
  68. package/src/api/cyberia-instance-conf/cyberia-instance-conf.router.js +27 -0
  69. package/src/api/cyberia-instance-conf/cyberia-instance-conf.service.js +42 -0
  70. package/src/api/cyberia-map/cyberia-map.controller.js +79 -0
  71. package/src/api/cyberia-map/cyberia-map.model.js +30 -0
  72. package/src/api/cyberia-map/cyberia-map.router.js +40 -0
  73. package/src/api/cyberia-map/cyberia-map.service.js +74 -0
  74. package/src/api/file/file.ref.json +18 -0
  75. package/src/api/ipfs/ipfs.controller.js +4 -25
  76. package/src/api/ipfs/ipfs.model.js +43 -34
  77. package/src/api/ipfs/ipfs.router.js +8 -13
  78. package/src/api/ipfs/ipfs.service.js +54 -102
  79. package/src/api/object-layer/README.md +347 -22
  80. package/src/api/object-layer/object-layer.router.js +30 -0
  81. package/src/api/object-layer/object-layer.service.js +114 -31
  82. package/src/api/user/user.service.js +8 -7
  83. package/src/cli/cluster.js +7 -7
  84. package/src/cli/db.js +710 -827
  85. package/src/cli/deploy.js +151 -93
  86. package/src/cli/env.js +29 -0
  87. package/src/cli/fs.js +5 -2
  88. package/src/cli/index.js +48 -2
  89. package/src/cli/kubectl.js +211 -0
  90. package/src/cli/release.js +284 -0
  91. package/src/cli/repository.js +438 -75
  92. package/src/cli/run.js +195 -35
  93. package/src/cli/secrets.js +73 -0
  94. package/src/cli/test.js +3 -3
  95. package/src/client/Cryptokoyn.index.js +3 -4
  96. package/src/client/CyberiaPortal.index.js +3 -4
  97. package/src/client/Default.index.js +3 -4
  98. package/src/client/Itemledger.index.js +3 -4
  99. package/src/client/Underpost.index.js +3 -4
  100. package/src/client/components/core/AppStore.js +69 -0
  101. package/src/client/components/core/CalendarCore.js +2 -2
  102. package/src/client/components/core/DropDown.js +137 -17
  103. package/src/client/components/core/Keyboard.js +2 -2
  104. package/src/client/components/core/LogIn.js +2 -2
  105. package/src/client/components/core/LogOut.js +2 -2
  106. package/src/client/components/core/Modal.js +0 -1
  107. package/src/client/components/core/Panel.js +0 -1
  108. package/src/client/components/core/PanelForm.js +19 -19
  109. package/src/client/components/core/SocketIo.js +82 -29
  110. package/src/client/components/core/SocketIoHandler.js +75 -0
  111. package/src/client/components/core/Stream.js +143 -95
  112. package/src/client/components/core/Webhook.js +40 -7
  113. package/src/client/components/cryptokoyn/AppStoreCryptokoyn.js +5 -0
  114. package/src/client/components/cryptokoyn/LogInCryptokoyn.js +3 -3
  115. package/src/client/components/cryptokoyn/LogOutCryptokoyn.js +2 -2
  116. package/src/client/components/cryptokoyn/MenuCryptokoyn.js +3 -3
  117. package/src/client/components/cryptokoyn/SocketIoCryptokoyn.js +3 -51
  118. package/src/client/components/cyberia/InstanceEngineCyberia.js +700 -0
  119. package/src/client/components/cyberia/MapEngineCyberia.js +1359 -2
  120. package/src/client/components/cyberia/ObjectLayerEngineModal.js +17 -6
  121. package/src/client/components/cyberia/ObjectLayerEngineViewer.js +92 -54
  122. package/src/client/components/cyberia-portal/AppStoreCyberiaPortal.js +5 -0
  123. package/src/client/components/cyberia-portal/CommonCyberiaPortal.js +216 -30
  124. package/src/client/components/cyberia-portal/LogInCyberiaPortal.js +3 -3
  125. package/src/client/components/cyberia-portal/LogOutCyberiaPortal.js +2 -2
  126. package/src/client/components/cyberia-portal/MenuCyberiaPortal.js +40 -7
  127. package/src/client/components/cyberia-portal/RoutesCyberiaPortal.js +4 -0
  128. package/src/client/components/cyberia-portal/SocketIoCyberiaPortal.js +3 -49
  129. package/src/client/components/cyberia-portal/TranslateCyberiaPortal.js +4 -0
  130. package/src/client/components/default/AppStoreDefault.js +5 -0
  131. package/src/client/components/default/LogInDefault.js +3 -3
  132. package/src/client/components/default/LogOutDefault.js +2 -2
  133. package/src/client/components/default/MenuDefault.js +5 -5
  134. package/src/client/components/default/SocketIoDefault.js +3 -51
  135. package/src/client/components/itemledger/AppStoreItemledger.js +5 -0
  136. package/src/client/components/itemledger/LogInItemledger.js +3 -3
  137. package/src/client/components/itemledger/LogOutItemledger.js +2 -2
  138. package/src/client/components/itemledger/MenuItemledger.js +3 -3
  139. package/src/client/components/itemledger/SocketIoItemledger.js +3 -51
  140. package/src/client/components/underpost/AppStoreUnderpost.js +5 -0
  141. package/src/client/components/underpost/LogInUnderpost.js +3 -3
  142. package/src/client/components/underpost/LogOutUnderpost.js +2 -2
  143. package/src/client/components/underpost/MenuUnderpost.js +5 -5
  144. package/src/client/components/underpost/SocketIoUnderpost.js +3 -51
  145. package/src/client/services/core/core.service.js +20 -8
  146. package/src/client/services/cyberia-dialogue/cyberia-dialogue.service.js +105 -0
  147. package/src/client/services/cyberia-entity/cyberia-entity.management.js +57 -0
  148. package/src/client/services/cyberia-entity/cyberia-entity.service.js +105 -0
  149. package/src/client/services/cyberia-instance/cyberia-instance.management.js +194 -0
  150. package/src/client/services/cyberia-instance/cyberia-instance.service.js +122 -0
  151. package/src/client/services/cyberia-instance-conf/cyberia-instance-conf.service.js +105 -0
  152. package/src/client/services/cyberia-map/cyberia-map.management.js +193 -0
  153. package/src/client/services/cyberia-map/cyberia-map.service.js +126 -0
  154. package/src/client/services/instance/instance.management.js +2 -2
  155. package/src/client/services/ipfs/ipfs.service.js +3 -23
  156. package/src/client/services/object-layer/object-layer.management.js +3 -3
  157. package/src/client/services/object-layer/object-layer.service.js +21 -0
  158. package/src/client/services/user/user.management.js +2 -2
  159. package/src/client/ssr/pages/CyberiaServerMetrics.js +1 -1
  160. package/src/grpc/cyberia/OFF_CHAIN_ECONOMY.md +305 -0
  161. package/src/grpc/cyberia/README.md +326 -0
  162. package/src/grpc/cyberia/grpc-server.js +530 -0
  163. package/src/index.js +24 -1
  164. package/src/runtime/express/Dockerfile +4 -0
  165. package/src/runtime/express/Express.js +18 -1
  166. package/src/runtime/lampp/Dockerfile +13 -2
  167. package/src/runtime/lampp/Lampp.js +27 -4
  168. package/src/runtime/wp/Dockerfile +68 -0
  169. package/src/runtime/wp/Wp.js +639 -0
  170. package/src/server/auth.js +24 -1
  171. package/src/server/backup.js +37 -9
  172. package/src/server/client-build-docs.js +9 -2
  173. package/src/server/client-build.js +31 -31
  174. package/src/server/client-formatted.js +109 -57
  175. package/src/server/conf.js +24 -9
  176. package/src/server/cron.js +25 -23
  177. package/src/server/dns.js +2 -1
  178. package/src/server/ipfs-client.js +24 -1
  179. package/src/server/object-layer.js +149 -108
  180. package/src/server/peer.js +8 -0
  181. package/src/server/runtime.js +25 -1
  182. package/src/server/semantic-layer-generator-floor.js +359 -0
  183. package/src/server/semantic-layer-generator-skin.js +1294 -0
  184. package/src/server/semantic-layer-generator.js +116 -555
  185. package/src/server/start.js +2 -2
  186. package/src/ws/IoInterface.js +1 -10
  187. package/src/ws/IoServer.js +14 -33
  188. package/src/ws/core/channels/core.ws.chat.js +65 -20
  189. package/src/ws/core/channels/core.ws.mailer.js +113 -32
  190. package/src/ws/core/channels/core.ws.stream.js +90 -31
  191. package/src/ws/core/core.ws.connection.js +12 -33
  192. package/src/ws/core/core.ws.emit.js +10 -26
  193. package/src/ws/core/core.ws.server.js +25 -58
  194. package/src/ws/default/channels/default.ws.main.js +53 -12
  195. package/src/ws/default/default.ws.connection.js +26 -13
  196. package/src/ws/default/default.ws.server.js +30 -12
  197. package/src/client/components/cryptokoyn/CommonCryptokoyn.js +0 -29
  198. package/src/client/components/cryptokoyn/ElementsCryptokoyn.js +0 -38
  199. package/src/client/components/cyberia-portal/ElementsCyberiaPortal.js +0 -38
  200. package/src/client/components/default/ElementsDefault.js +0 -38
  201. package/src/client/components/itemledger/CommonItemledger.js +0 -29
  202. package/src/client/components/itemledger/ElementsItemledger.js +0 -38
  203. package/src/client/components/underpost/CommonUnderpost.js +0 -29
  204. package/src/client/components/underpost/ElementsUnderpost.js +0 -38
  205. package/src/ws/core/management/core.ws.chat.js +0 -8
  206. package/src/ws/core/management/core.ws.mailer.js +0 -16
  207. package/src/ws/core/management/core.ws.stream.js +0 -8
  208. package/src/ws/default/management/default.ws.main.js +0 -8
@@ -0,0 +1,305 @@
1
+ # Off-Chain Economy — Fountain & Sink Architecture
2
+
3
+ > **Status:** Alpha (sinks disabled; all values reset on reconnect).
4
+ > **On-chain bridge:** Planned — CKY ERC-1155 token (token ID 0) on Hyperledger Besu.
5
+ > See `hardhat/WHITE-PAPER.md §7 Tokenomics` for the bridge protocol.
6
+
7
+ ---
8
+
9
+ ## 1. Model Overview
10
+
11
+ This game uses the **Fountain & Sink** economy model — the industry standard for
12
+ sustainable in-game economies, pioneered by _Ultima Online_ and perfected in
13
+ _EVE Online_ and _World of Warcraft_.
14
+
15
+ ```
16
+ ┌─────────────────────────────┐
17
+ │ FOUNTAINS │
18
+ │ (inject coins into economy) │
19
+ │ │
20
+ │ botSpawnCoins ──► Bot │
21
+ │ playerSpawnCoins ► Player │
22
+ └──────────────┬──────────────┘
23
+ │ new coins
24
+
25
+ ┌──────────────────────────────┐
26
+ │ CIRCULATING SUPPLY │
27
+ │ (player & bot wallets) │
28
+ └──────┬───────────────────────┘
29
+
30
+ ┌────────────┴────────────┐
31
+ │ KILL TRANSFER │ zero-sum: no new coins created
32
+ │ (redistribution) │ loser → winner
33
+ │ │
34
+ │ PvE: coinKillPercentVsBot │
35
+ │ PvP: coinKillPercentVsPlayer │
36
+ │ floor: coinKillMinAmount │
37
+ └────────────┬────────────┘
38
+
39
+ ┌──────▼──────────────────────┐
40
+ │ SINKS │
41
+ │ (destroy coins, alpha=0) │
42
+ │ │
43
+ │ respawnCostPercent │
44
+ │ portalFee │
45
+ │ craftingFeePercent │
46
+ └─────────────────────────────┘
47
+ ```
48
+
49
+ ### Core rules
50
+
51
+ | Rule | Description |
52
+ | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
53
+ | **Bots are infinite mint** | Every bot respawn resets its wallet to `botSpawnCoins`. The supply is only bounded by player activity (kill rate). |
54
+ | **Players are zero-sum** | Killing a player transfers coins but does not create new ones. PvP is redistribution only. |
55
+ | **Kill floor** | `coinKillMinAmount` guarantees every successful kill pays out, even against a near-empty wallet. |
56
+ | **Sinks scale with economy** | Portal fees and respawn costs burn a fraction — more activity = more burn. Keeps the economy from inflating indefinitely. |
57
+
58
+ ---
59
+
60
+ ## 2. Configuration Structure
61
+
62
+ Economy parameters live in a dedicated `economyRules` sub-document inside
63
+ `CyberiaInstanceConf`, exactly mirroring the `skillRules` pattern.
64
+
65
+ ### 2.1 JavaScript defaults (`cyberia-instance-conf.defaults.js`)
66
+
67
+ ```js
68
+ economyRules: {
69
+ // ── Fountains ──────────────────────────────────────────────────────
70
+ botSpawnCoins: 50, // coins on bot spawn / respawn (infinite mint)
71
+ playerSpawnCoins: 50, // guest starting wallet (resets on reconnect)
72
+
73
+ // ── Kill Transfer ───────────────────────────────────────────────────
74
+ coinKillPercentVsBot: 0.4, // 40 % of bot wallet → killer on PvE kill
75
+ coinKillPercentVsPlayer: 0.15, // 15 % of player wallet → killer on PvP kill
76
+ coinKillMinAmount: 10, // minimum coins per kill (hard floor)
77
+
78
+ // ── Sinks (alpha: all 0 = disabled) ────────────────────────────────
79
+ respawnCostPercent: 0.0, // fraction burned on player death
80
+ portalFee: 0, // flat coins burned per portal use
81
+ craftingFeePercent: 0.0, // fraction burned per crafting action
82
+ },
83
+ ```
84
+
85
+ ### 2.2 Mongoose schema (`cyberia-instance-conf.model.js`)
86
+
87
+ ```js
88
+ // EconomyRulesSchema — mirrors defaults above
89
+ economyRules: {
90
+ type: EconomyRulesSchema;
91
+ }
92
+ ```
93
+
94
+ The schema validates each field against the default value so a freshly created
95
+ document is immediately playable without any explicit configuration.
96
+
97
+ ### 2.3 Protobuf message (`proto/cyberia.proto`)
98
+
99
+ ```proto
100
+ message EconomyRules {
101
+ int32 bot_spawn_coins = 1;
102
+ int32 player_spawn_coins = 2;
103
+ double coin_kill_percent_vs_bot = 3;
104
+ double coin_kill_percent_vs_player = 4;
105
+ int32 coin_kill_min_amount = 5;
106
+ double respawn_cost_percent = 6;
107
+ int32 portal_fee = 7;
108
+ double crafting_fee_percent = 8;
109
+ }
110
+
111
+ // Used in InstanceConfig:
112
+ EconomyRules economy_rules = 62;
113
+ ```
114
+
115
+ ### 2.4 Go server (`src/server.go` → `ApplyInstanceConfig`)
116
+
117
+ ```go
118
+ er := cfg.GetEconomyRules()
119
+ if er == nil { er = &pb.EconomyRules{} }
120
+
121
+ s.botSpawnCoins = int(er.GetBotSpawnCoins())
122
+ s.playerSpawnCoins = int(er.GetPlayerSpawnCoins())
123
+ s.coinKillPercentVsBot = er.GetCoinKillPercentVsBot()
124
+ s.coinKillPercentVsPlayer = er.GetCoinKillPercentVsPlayer()
125
+ s.coinKillMinAmount = int(er.GetCoinKillMinAmount())
126
+ s.respawnCostPercent = er.GetRespawnCostPercent()
127
+ s.portalFee = int(er.GetPortalFee())
128
+ s.craftingFeePercent = er.GetCraftingFeePercent()
129
+ ```
130
+
131
+ ---
132
+
133
+ ## 3. Runtime Economy API (`src/economy.go`)
134
+
135
+ All economy logic is encapsulated in a single file to enforce the single-source
136
+ principle. Callers (`handlers.go`, `collision.go`, `skill.go`) call named methods
137
+ and never manipulate coin wallets directly.
138
+
139
+ ### Method reference
140
+
141
+ | Method | Caller | Description |
142
+ | ------------------------------------- | ---------------------------------- | ----------------------------------------------------------- |
143
+ | `FountainInitPlayer(player)` | `handlers.go` on WebSocket connect | Credits `playerSpawnCoins` to new player |
144
+ | `FountainInitBot(bot)` | `collision.go` on bot respawn | Resets bot wallet to `botSpawnCoins` (infinite mint) |
145
+ | `ExecuteKillTransfer(caster, victim)` | `skill.go HandleOnKillSkills` | Transfers coins based on kill scenario (all 4 combinations) |
146
+ | `SinkRespawnCost(player)` | `collision.go handlePlayerDeath` | Burns `respawnCostPercent`% of player coins (0 = no-op) |
147
+ | `SinkPortalFee(player)` | Portal handler _(future)_ | Burns flat `portalFee` coins on portal use (0 = no-op) |
148
+
149
+ ### Kill transfer scenarios
150
+
151
+ ```
152
+ ExecuteKillTransfer(caster, victim):
153
+
154
+ if caster=Player, victim=Bot → PvE rate (coinKillPercentVsBot)
155
+ if caster=Player, victim=Player → PvP rate (coinKillPercentVsPlayer)
156
+ if caster=Bot, victim=Player → PvP rate (bot kills player)
157
+ if caster=Bot, victim=Bot → PvE rate (bot kills bot, e.g. friendly fire)
158
+
159
+ transfer = max(floor(victim.coins * rate), coinKillMinAmount)
160
+ transfer = min(transfer, victim.coins) -- can't take more than available
161
+ victim.coins -= transfer
162
+ caster.coins += transfer -- bots ignore received coins
163
+ sendFCT(caster, FCTTypeCoinGain, ...)
164
+ sendFCT(victim, FCTTypeCoinLoss, ...)
165
+ ```
166
+
167
+ ---
168
+
169
+ ## 4. Floating Combat Text (FCT) Wire Protocol
170
+
171
+ Economy events trigger client-side visual feedback via the binary AOI protocol.
172
+
173
+ ```
174
+ MsgTypeFCT = 0x04 (14 bytes, little-endian)
175
+
176
+ Offset Size Field
177
+ ────── ──── ──────────────────────────────────────
178
+ 0 u8 message type (0x04)
179
+ 1 u8 fct_type (see table below)
180
+ 2 f32 world_x (entity position)
181
+ 6 f32 world_y
182
+ 10 u32 value (always positive; sign implied by type)
183
+ ```
184
+
185
+ | `fct_type` | Constant | Color | Display |
186
+ | ---------- | ----------------- | ------ | -------------- |
187
+ | `0x00` | `FCTTypeDamage` | Red | `-N` HP lost |
188
+ | `0x01` | `FCTTypeRegen` | Green | `+N` HP gained |
189
+ | `0x02` | `FCTTypeCoinGain` | Yellow | `+N` coins |
190
+ | `0x03` | `FCTTypeCoinLoss` | Yellow | `-N` coins |
191
+
192
+ ---
193
+
194
+ ## 5. MongoDB Document Example
195
+
196
+ A complete `CyberiaInstanceConf` document with economy configured:
197
+
198
+ ```json
199
+ {
200
+ "instanceCode": "alpha-01",
201
+ "cellSize": 45,
202
+ "fps": 60,
203
+ "economyRules": {
204
+ "botSpawnCoins": 50,
205
+ "playerSpawnCoins": 50,
206
+ "coinKillPercentVsBot": 0.4,
207
+ "coinKillPercentVsPlayer": 0.15,
208
+ "coinKillMinAmount": 10,
209
+ "respawnCostPercent": 0.0,
210
+ "portalFee": 0,
211
+ "craftingFeePercent": 0.0
212
+ },
213
+ "skillRules": {
214
+ "projectileSpawnChance": 0.5,
215
+ "projectileLifetimeMs": 2000,
216
+ "projectileWidth": 1,
217
+ "projectileHeight": 1,
218
+ "projectileSpeedMultiplier": 3,
219
+ "doppelgangerSpawnChance": 0.5,
220
+ "doppelgangerLifetimeMs": 5000,
221
+ "doppelgangerSpawnRadius": 3,
222
+ "doppelgangerInitialLifeFraction": 1.0
223
+ }
224
+ }
225
+ ```
226
+
227
+ ---
228
+
229
+ ## 6. gRPC / Config Builder
230
+
231
+ The `toInstanceConfig()` function in `grpc-server.js` resolves `economyRules`
232
+ with a simple two-tier fallback:
233
+
234
+ ```
235
+ priority: gc.economyRules.field (instance document in MongoDB)
236
+ → fb.economyRules.field (CYBERIA_INSTANCE_CONF_DEFAULTS — always set)
237
+ ```
238
+
239
+ All economy state lives exclusively in `economyRules`. There is no flat-field
240
+ fallback chain. A document without an `economyRules` sub-document receives
241
+ the canonical defaults automatically.
242
+
243
+ ---
244
+
245
+ ## 7. Enabling Sinks (Graduation from Alpha)
246
+
247
+ When you want to activate the economy pressure levers, update `economyRules` in
248
+ the DB document for the target instance:
249
+
250
+ ```json
251
+ {
252
+ "economyRules": {
253
+ "respawnCostPercent": 0.1,
254
+ "portalFee": 5,
255
+ "craftingFeePercent": 0.05
256
+ }
257
+ }
258
+ ```
259
+
260
+ The Go server picks up changes on the next `LoadAll` / hot-reload via gRPC.
261
+ No binary redeployment is needed.
262
+
263
+ Recommended progression:
264
+
265
+ 1. **Alpha** — all sinks at 0; fountains generous (50 coins/spawn).
266
+ 2. **Beta** — `respawnCostPercent: 0.05`, bots at 30 coins.
267
+ 3. **Live** — tune all three sinks; enable on-chain bridge.
268
+
269
+ ---
270
+
271
+ ## 8. On-Chain Bridge (Future)
272
+
273
+ ```
274
+ Off-chain wallet (in-memory)
275
+ │ on authenticate (secp256k1 sig)
276
+
277
+ ERC-1155 CKY token (token ID 0) ← ObjectLayerToken contract
278
+ │ on session end / explicit withdraw
279
+
280
+ Player's Hyperledger Besu wallet
281
+ ```
282
+
283
+ Until the bridge is live every economy event is ephemeral:
284
+
285
+ - Wallets reset to `playerSpawnCoins` on every reconnect.
286
+ - Bot wallets reset to `botSpawnCoins` on every respawn.
287
+ - No cross-session coin persistence.
288
+
289
+ This is intentional — the off-chain fallback lets the economy be tuned and
290
+ battle-tested before committing values to an immutable ledger.
291
+
292
+ ---
293
+
294
+ ## 9. Field Reference
295
+
296
+ | Field | Type | Default | Scope |
297
+ | -------------------------------------- | ------------- | ------- | ------------- |
298
+ | `economyRules.botSpawnCoins` | `int` | `50` | Fountain |
299
+ | `economyRules.playerSpawnCoins` | `int` | `50` | Fountain |
300
+ | `economyRules.coinKillPercentVsBot` | `float` [0,1] | `0.4` | Kill Transfer |
301
+ | `economyRules.coinKillPercentVsPlayer` | `float` [0,1] | `0.15` | Kill Transfer |
302
+ | `economyRules.coinKillMinAmount` | `int` | `10` | Kill Transfer |
303
+ | `economyRules.respawnCostPercent` | `float` [0,1] | `0.0` | Sink |
304
+ | `economyRules.portalFee` | `int` | `0` | Sink |
305
+ | `economyRules.craftingFeePercent` | `float` [0,1] | `0.0` | Sink |
@@ -0,0 +1,326 @@
1
+ # Cyberia gRPC Data Pipeline
2
+
3
+ Internal gRPC server that exposes read-only RPCs over MongoDB data for the Go game server (`cyberia-server`).
4
+
5
+ ## Architecture
6
+
7
+ ```mermaid
8
+ graph LR
9
+ engine["Node.js Engine\nMongoDB + Express\ngrpc-server.js"]
10
+ go["Go Game Server\ncyberia-server\ngrpcclient/world_builder.go"]
11
+
12
+ engine -->|"gRPC :50051\nGetFullInstance\nGetObjectLayerBatch\nGetMapData \u00b7 Ping"| go
13
+ ```
14
+
15
+ ## Data Flow
16
+
17
+ ```
18
+ MongoDB (CyberiaInstance + CyberiaMap + ObjectLayer)
19
+
20
+
21
+ Node.js Engine (grpc-server.js)
22
+ │ getFullInstance → instance graph + maps + entities + objectLayers + InstanceConfig
23
+ │ getObjectLayerBatch → stream all ObjectLayers
24
+ │ getObjectLayerManifest → itemId + sha256 pairs (for hot-reload diffing)
25
+ │ ping → liveness check
26
+
27
+ Go Game Server (world_builder.go → instance_loader.go → server.go)
28
+ │ ApplyInstanceConfig → sets all game parameters from gRPC
29
+ │ BuildWorldFromInstance → builds maps, entities, portals from gRPC data
30
+ │ ReplaceObjectLayerCache → caches ObjectLayer metadata
31
+
32
+ C/WASM Client (WebSocket binary AOI protocol)
33
+ │ init_data → game config, player state, grid dimensions
34
+ │ metadata → ObjectLayer cache (delivered once after connect)
35
+ │ aoi_update → binary-encoded entity positions, directions, modes, colors, item stacks
36
+ ```
37
+
38
+ ### Fallback Instance
39
+
40
+ When `getFullInstance` is called with an instance code that does not exist in MongoDB, the Engine returns a **minimal playable fallback** instead of `NOT_FOUND`:
41
+
42
+ - 1 empty map (64×64 floor grid, no obstacles, no bots, no portals)
43
+ - No ObjectLayers, no AtlasSpriteSheets
44
+ - `buildFallbackConfig()` provides playable defaults (speed, life, AOI, etc.)
45
+ - Players are rendered as solid colored rectangles using the `PLAYER` color from the instance's color palette (no sprites needed)
46
+
47
+ The Go server **always** requires gRPC — if the Engine is unreachable it exits with a fatal error. The fallback is purely Engine-side: `getFullInstance` with an unknown code returns a synthetic response, not `NOT_FOUND`.
48
+
49
+ ### Skill System: itemId → logicEventIds
50
+
51
+ The skill pipeline maps trigger item IDs to ordered lists of logic handler keys:
52
+
53
+ ```
54
+ CyberiaInstanceConf.skillConfig[] (MongoDB)
55
+ ├─ triggerItemId: "atlas_pistol_mk2" ← item in player's active object layer
56
+ └─ logicEventIds: ["atlas_pistol_mk2_logic"] ← ordered handler keys executed in sequence
57
+
58
+ CyberiaInstanceConf.skillRules (MongoDB) → SkillRules proto message → GameServer fields
59
+ ├─ bulletSpawnChance / bulletLifetimeMs / bulletWidth / bulletHeight / bulletSpeedMultiplier
60
+ └─ doppelgangerSpawnChance / doppelgangerLifetimeMs / doppelgangerSpawnRadius / doppelgangerInitialLifeFraction
61
+
62
+ Go runtime:
63
+ 1. Player performs action
64
+ 2. Iterate active object layers → s.skillConfig[layer.ItemID] → []SkillDefinition
65
+ 3. For each SkillDefinition, iterate LogicEventIDs in order:
66
+ "doppelganger" → executePlayerDoppelgangerSkill()
67
+ "atlas_pistol_mk2_logic" → executePlayerBulletSkill() (bullet item ID is internal to the handler)
68
+ ```
69
+
70
+ Spawning new entities (e.g. bullets) is handled entirely inside the logic handler — no `spawnedItemIds` config is needed.
71
+
72
+ ## Configuration
73
+
74
+ Add `grpc` to the host conf in `conf.dd-cyberia.js`:
75
+
76
+ ```js
77
+ 'www.cyberiaonline.com': {
78
+ '/': {
79
+ db: { provider: 'mongoose', host: 'env:DB_HOST', name: 'env:DB_NAME_CYBERIA' },
80
+ grpc: { port: 50051 },
81
+ // ...
82
+ },
83
+ },
84
+ ```
85
+
86
+ The gRPC server starts automatically after `DataBaseProvider.load()` when the `grpc` key is present.
87
+
88
+ ### mTLS (optional)
89
+
90
+ For production environments with network-separated services:
91
+
92
+ ```js
93
+ grpc: {
94
+ port: 50051,
95
+ tls: {
96
+ caPath: '/path/to/ca.pem',
97
+ certPath: '/path/to/server-cert.pem',
98
+ keyPath: '/path/to/server-key.pem',
99
+ },
100
+ },
101
+ ```
102
+
103
+ The Go client (`cyberia-server/src/grpcclient/client.go`) supports the same mTLS config via `CACertPath`, `ClientCertPath`, `ClientKeyPath`.
104
+
105
+ ## Auth
106
+
107
+ No application-level auth is required. This is a **private cluster-internal** channel:
108
+
109
+ - Both services run on the same host or within a trusted network
110
+ - The Go server is the only consumer — it dials `localhost:50051` by default
111
+ - mTLS provides mutual authentication when services are network-separated
112
+ - No user credentials or tokens flow over this channel — it's a data relay, not a user-facing API
113
+
114
+ ## Proto
115
+
116
+ Service definition: [`cyberia-server/proto/cyberia.proto`](../../../cyberia-server/proto/cyberia.proto)
117
+
118
+ After editing the proto, regenerate Go code:
119
+
120
+ ```sh
121
+ cd cyberia-server
122
+ export PATH=$PATH:$(go env GOPATH)/bin
123
+ protoc --go_out=. --go_opt=paths=source_relative \
124
+ --go-grpc_out=. --go-grpc_opt=paths=source_relative \
125
+ proto/cyberia.proto
126
+ ```
127
+
128
+ ## Runtime Modes
129
+
130
+ The gRPC server starts in **all** engine runtime modes that load `conf.server.json`:
131
+
132
+ | npm script | NODE_ENV | gRPC starts? | Notes |
133
+ | ------------------------ | ----------- | ------------ | ----------------------------------- |
134
+ | `npm start` | _(none)_ | Yes | Production entry point |
135
+ | `npm run dev` | development | Yes | Nodemon auto-restart |
136
+ | `npm run dev:container` | development | Yes | Docker development |
137
+ | `npm run prod:container` | production | Yes | Docker production |
138
+ | `npm run dev:api` | development | **No** | API-only mode, no Express lifecycle |
139
+
140
+ ## Environment Variables
141
+
142
+ ### Engine (Node.js) — set in `.env` or `conf.dd-cyberia.js`
143
+
144
+ | Variable | Description |
145
+ | ----------------- | --------------------- |
146
+ | `DB_HOST` | MongoDB host |
147
+ | `DB_NAME_CYBERIA` | MongoDB database name |
148
+ | `VALKEY_HOST` | Valkey (Redis) host |
149
+ | `VALKEY_PORT` | Valkey port |
150
+
151
+ ### Go Server — set in `.env` or environment
152
+
153
+ | Variable | Default | Description |
154
+ | --------------------------------- | ----------------- | -------------------------------------------------- |
155
+ | `ENGINE_GRPC_ADDRESS` | `localhost:50051` | Engine gRPC server address — **required** |
156
+ | `INSTANCE_CODE` | `default` | Instance code to load on startup |
157
+ | `ENGINE_API_BASE_URL` | _(empty)_ | Engine HTTP base URL (forwarded to clients) |
158
+ | `ENGINE_GRPC_RELOAD_INTERVAL_SEC` | _(disabled)_ | ObjectLayer hot-reload polling interval in seconds |
159
+ | `SERVER_PORT` | `8081` | HTTP/WS server listen port |
160
+ | `STATIC_DIR` | `./public` | Directory for static WASM client files |
161
+ | `ENGINE_GRPC_CA_CERT` | _(empty)_ | CA certificate for mTLS |
162
+ | `ENGINE_GRPC_CLIENT_CERT` | _(empty)_ | Client certificate for mTLS |
163
+ | `ENGINE_GRPC_CLIENT_KEY` | _(empty)_ | Client private key for mTLS |
164
+
165
+ ### C/WASM Client — compile-time constants in `src/config.h`
166
+
167
+ | Constant | Development | Production |
168
+ | --------------- | ------------------------ | ----------------------------------- |
169
+ | `WS_URL` | `ws://localhost:8081/ws` | `wss://server.cyberiaonline.com/ws` |
170
+ | `API_BASE_URL` | `http://localhost:4005` | `https://www.cyberiaonline.com` |
171
+ | `GHOST_ITEM_ID` | `ghost` | `ghost` |
172
+
173
+ ## Development
174
+
175
+ Run all three components locally in separate terminals:
176
+
177
+ ```sh
178
+ # Terminal 1: Engine (Node.js — Express + MongoDB + gRPC :50051)
179
+ cd /home/dd/engine
180
+ npm run dev
181
+
182
+ # Terminal 2: Go game server (WS :8081 + REST /api/v1/*)
183
+ cd /home/dd/engine/cyberia-server
184
+ cat > .env << 'EOF'
185
+ ENGINE_GRPC_ADDRESS=localhost:50051
186
+ INSTANCE_CODE=cyberia-main
187
+ ENGINE_API_BASE_URL=http://localhost:4005
188
+ SERVER_PORT=8081
189
+ EOF
190
+ go run main.go
191
+
192
+ # Terminal 3: C/WASM client (static :8082)
193
+ cd /home/dd/engine/cyberia-client
194
+ # Edit src/config.h:
195
+ # WS_URL = "ws://localhost:8081/ws"
196
+ # API_BASE_URL = "http://localhost:4005"
197
+ source ~/.emsdk/emsdk_env.sh
198
+ make -f Web.mk clean && make -f Web.mk web
199
+ make -f Web.mk serve-development # http://localhost:8082
200
+ ```
201
+
202
+ ### Startup order
203
+
204
+ ```
205
+ 1. Engine (npm run dev) → gRPC server listens on :50051
206
+ 2. Go server (go run main.go) → dials :50051, loads instance, WS on :8081
207
+ 3. C client (serve-development) → opens browser, connects WS to :8081
208
+ ```
209
+
210
+ If `INSTANCE_CODE` doesn't match a database record, the Engine returns a minimal fallback instance — the Go server starts normally. If the Engine is not running, the Go server exits (gRPC is required).
211
+
212
+ ### Dev ports summary
213
+
214
+ | Component | Port | Protocol |
215
+ | -------------- | ----- | --------- |
216
+ | Engine Express | 4005+ | HTTP |
217
+ | Engine gRPC | 50051 | gRPC |
218
+ | Go server | 8081 | HTTP + WS |
219
+ | C client | 8082 | HTTP |
220
+
221
+ ## Production
222
+
223
+ ### Kubernetes deployment order
224
+
225
+ ```
226
+ 1. Engine (dd-cyberia) ← Express :4005-4014, gRPC :50051 (cluster-internal)
227
+ 2. Go server (mmo-server) ← ENGINE_GRPC_ADDRESS=<engine-clusterIP>:50051
228
+ 3. C client (mmo-client) ← static WASM files served on :8082
229
+ ```
230
+
231
+ ### C client production build
232
+
233
+ ```sh
234
+ cd /home/dd/engine/cyberia-client
235
+ # Ensure src/config.h has production URLs:
236
+ # WS_URL = "wss://server.cyberiaonline.com/ws"
237
+ # API_BASE_URL = "https://www.cyberiaonline.com"
238
+ source ~/.emsdk/emsdk_env.sh
239
+ make -f Web.mk clean && make -f Web.mk web BUILD_MODE=RELEASE
240
+ make -f Web.mk serve-production # http://localhost:8082
241
+ ```
242
+
243
+ ### Go server with embedded client
244
+
245
+ The Go server can serve the WASM client directly via `STATIC_DIR`:
246
+
247
+ ```sh
248
+ # Copy WASM build output to Go server's public dir
249
+ cp -r cyberia-client/bin/web/release/* cyberia-server/public/
250
+
251
+ # Go server serves both WS and static files on :8081
252
+ STATIC_DIR=./public go run main.go
253
+ ```
254
+
255
+ In Kubernetes, each runs in its own pod behind Contour/Envoy:
256
+
257
+ ```
258
+ Contour/Envoy (L7 proxy, TLS termination via cert-manager)
259
+ ├─ www.cyberiaonline.com → Engine pods (:4005)
260
+ │ server.cyberiaonline.com → Go server pod (:8081) ← WS + REST
261
+ │ client.cyberiaonline.com → Client pod (:8082) ← WASM static
262
+ ```
263
+
264
+ Port 50051 (gRPC) is **not** exposed via Contour — it is cluster-internal only.
265
+
266
+ ### TLS
267
+
268
+ - **External**: cert-manager + LetsEncrypt (ACME HTTP-01) for `*.cyberiaonline.com`
269
+ - **Internal gRPC**: No TLS needed for same-cluster. mTLS only if cross-cluster.
270
+
271
+ ### Hot-reload
272
+
273
+ When `ENGINE_GRPC_RELOAD_INTERVAL_SEC` is set, the Go server periodically:
274
+
275
+ 1. Pings the Engine for liveness
276
+ 2. Fetches ObjectLayer manifest (itemId + sha256 pairs)
277
+ 3. Diffs against local cache
278
+ 4. Re-fetches only changed/new ObjectLayers
279
+ 5. Removes deleted ObjectLayers
280
+
281
+ ## CD Workflows
282
+
283
+ All three repos use `workflow_dispatch` for manual triggers + commit-message triggers:
284
+
285
+ | Repo | Trigger | Job |
286
+ | ---------------- | ------------------------------------ | ----------------------------- |
287
+ | `engine` | `cd(ssh-engine-cyberia)` or dispatch | deploy, sync-and-deploy, init |
288
+ | `cyberia-server` | `cd(ssh-cyberia-server)` or dispatch | deploy |
289
+ | `cyberia-client` | `cd(ssh-cyberia-client)` or dispatch | deploy |
290
+
291
+ ## KubeAdm Cluster Topology
292
+
293
+ ```mermaid
294
+ graph TD
295
+ internet(["🌐 Internet\nHTTPS / WSS"])
296
+
297
+ subgraph cluster["KubeAdm Cluster"]
298
+ subgraph contour["Contour / Envoy — L7 proxy · cert-manager TLS"]
299
+ proxy["HTTPProxy\n*.cyberiaonline.com"]
300
+ end
301
+
302
+ subgraph dd_cyberia["dd-cyberia Pod (blue/green)"]
303
+ engine["Node.js Engine :4005-4014\nExpress · MongoDB · Valkey · Mailer"]
304
+ grpc_srv["gRPC server :50051\ncluster-internal only"]
305
+ engine --- grpc_srv
306
+ end
307
+
308
+ subgraph mmo_server["dd-cyberia-mmo-server Pod"]
309
+ go_srv["Go game server :8081\nWebSocket /ws · REST /api/v1/*"]
310
+ end
311
+
312
+ subgraph mmo_client["dd-cyberia-mmo-client Pod"]
313
+ wasm["WASM static server :8082\ncyberia-client (Raylib/Emscripten)"]
314
+ end
315
+
316
+ cfg["ConfigMap underpost-config\n.env.production"]
317
+ end
318
+
319
+ internet -->|HTTPS/WSS| proxy
320
+ proxy -->|"www.cyberiaonline.com → :4005"| engine
321
+ proxy -->|"server.cyberiaonline.com → :8081"| go_srv
322
+ proxy -->|"client.cyberiaonline.com → :8082"| wasm
323
+ grpc_srv -->|"gRPC GetFullInstance\nGetObjectLayerBatch\nHot-reload"| go_srv
324
+ cfg -.->|env vars| dd_cyberia
325
+ cfg -.->|env vars| mmo_server
326
+ ```