forked from colyseus/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
366 lines (335 loc) · 14.8 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
# Project information
site_name: "Colyseus & Arena Cloud Documentation"
site_description: "Documentation for Colyseus Multiplayer Framework for Node.js"
site_author: "Endel Dreyer & Fazri Zubair"
site_url: "https://colyseus.io/"
edit_uri: "https://github.com/colyseus/docs/edit/master/docs/"
# Deployment
remote_name: "origin"
remote_branch: "gh-pages"
# Repository
repo_name: "colyseus/colyseus"
repo_url: "https://github.com/colyseus/colyseus"
# Copyright
copyright: "Copyright © 2021 Lucid Sight"
google_analytics: ["UA-108278048-3", "docs.colyseus.io"]
# Documentation and theme
theme:
name: "material"
custom_dir: theme_overrides
language: "en"
logo: "images/logo-white.png"
favicon: "images/favicon.png"
palette:
primary: "indigo"
accent: "indigo"
font:
text: "Roboto"
code: "Roboto Mono"
features:
- navigation.indexes
- navigation.sections
- navigation.top
- navigation.tabs
plugins:
- search:
lang:
- en
- de
- pt
- i18n:
default_language: "en"
languages:
en: "English"
zh_CN: "简体中文" #Simplified Chinese
zh_HK: "繁體中文" # Traditional Chinese
# pt: "Português" # Portuguese
# de: "Deutsch" # German
# hi: "हिंदी" # Hindi
# fr: "Français" # French
nav_translations:
en:
getting started: "Getting started"
Client-side SDK: "Client-side SDK"
Installation: "Installation"
Unity: "Unity"
Deployment: "Deployment"
Production Deployments: "Production Deployments"
Managing Deployments: "Managing Deployments"
Reference: "Reference"
Tech Demos: "Tech Demos"
Shooting Gallery: "Shooting Gallery"
Tanks: "Tanks"
StarBoss: "StarBoss"
MMO: "MMO"
Migrating: "Migrating"
zh_CN:
getting started: "开始"
Client-side SDK: "客户端 SDK"
Installation: "安装"
Unity: "Unity"
Deployment: "部署"
Production Deployments: "生产部署"
Managing Deployments: "管理部署"
Reference: "参考资料"
Colyseus for Arena Cloud: "托管于 Arena Cloud 之上的 Colyseus"
Uploading Server Code: "上传服务器代码"
Usage: "使用"
Server API: "服务器 API"
Room: "房间"
Timing events: "计时事件"
Match-maker API: "房间匹配 API"
Presence: "多进程共享"
Transport: "传输"
Graceful shutdown: "优雅关闭"
State Synchronization: "状态数据同步"
Overview: "概览"
Schema: "Schema"
Best practices: "最佳实践"
Built-in Rooms: "内置房间"
Lobby room: "大厅房间"
Relay room: "中继房间"
Tools: "工具"
Unit Testing: "单元测试"
Monitoring Panel: "监控面板"
Load Testing: "负载测试"
Authentication + Social: "认证 + 社交"
Debugging: "调试"
Scalability: "可扩展性"
How-to: "操作说明"
Customize room id: "自定义房间 ID"
Password-protect a room: "使用密码保护房间"
Deny a player joining a room: "拒绝玩家加入房间"
Rate-limit: "速率限制"
Setup server from scratch (TS): "从头开始安装服务器 (TS)"
Tech Demos: "技术演示"
Shooting Gallery: "Shooting Gallery"
Tanks: "Tanks"
StarBoss: "StarBoss"
MMO: "MMO"
Migrating: "更新记录"
zh_HK:
getting started: "開始"
Client-side SDK: "客戶端 SDK"
Installation: "安裝"
Unity: "Unity"
Deployment: "部署"
Production Deployments: "生產部署"
Managing Deployments: "管理部署"
Reference: "參考資料"
Colyseus for Arena Cloud: "托管於 Arena Cloud 之上的 Colyseus"
Uploading Server Code: "上傳服務器代碼"
Usage: "使用"
Server API: "服務器 API"
Room: "房間"
Timing events: "計時事件"
Match-maker API: "房間匹配 API"
Presence: "多進程共享"
Transport: "傳輸"
Graceful shutdown: "優雅關閉"
State Synchronization: "狀態數據同步"
Overview: "概覽"
Schema: "Schema"
Best practices: "最佳實踐"
Built-in Rooms: "內置房間"
Lobby room: "大廳房間"
Relay room: "中繼房間"
Tools: "工具"
Unit Testing: "單元測試"
Monitoring Panel: "監控面板"
Load Testing: "負載測試"
Authentication + Social: "認證 + 社交"
Debugging: "調試"
Scalability: "可擴展性"
How-to: "操作說明"
Customize room id: "自定義房間 ID"
Password-protect a room: "使用密碼保護房間"
Deny a player joining a room: "拒絕玩家加入房間"
Rate-limit: "速率限製"
Setup server from scratch (TS): "從頭開始安裝服務器 (TS)"
Tech Demos: "技術演示"
Shooting Gallery: "Shooting Gallery"
Tanks: "Tanks"
StarBoss: "StarBoss"
MMO: "MMO"
Migrating: "更新記錄"
# pt:
# getting started: "Introdução"
# Client-side SDK: "Client-side SDK"
# Installation: "Instalação"
# Unity: "TBD"
# Deployment: "TBD"
# Production Deployments: "TBD"
# Managing Deployments: "TBD"
# Reference: "TBD"
# de:
# getting started: 'Einstieg'
# Client-side SDK: "Clientseitiges SDK"
# Installation: "Installation"
# Unity: "TBD"
# Deployment: "Einsatz"
# Production Deployments: "TBD"
# Managing Deployments: "TBD"
# Reference: "TBD"
# hi:
# getting started: "TBD"
# Client-side SDK: "TBD"
# Installation: "TBD"
# Unity: "TBD"
# Deployment: "TBD"
# Production Deployments: "TBD"
# Managing Deployments: "TBD"
# Reference: "TBD"
# fr:
# getting started: "TBD"
# Client-side SDK: "TBD"
# Installation: "TBD"
# Unity: "TBD"
# Deployment: "TBD"
# Production Deployments: "TBD"
# Managing Deployments: "TBD"
# Reference: "TBD"
extra_css:
- "stylesheets/custom.css"
# - 'stylesheets/ads.css'
# - 'https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.1.0/styles/github.min.css' # syntax highlight
- "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.1.0/styles/github-dark.min.css" # syntax highlight
extra_javascript:
# - 'javascripts/ads.js'
- "javascripts/main.js"
- "https://docs.colyseus.io/javascripts/previous_versions.js"
# - 'javascripts/previous_versions.js'
# syntax highlight
- "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.1.0/highlight.min.js"
- "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.1.0/languages/javascript.min.js"
- "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.1.0/languages/typescript.min.js"
- "javascripts/config.js"
# Options
extra:
# search:
# language: 'en'
social:
- icon: "fontawesome/solid/globe"
link: "http://colyseus.io"
- icon: "fontawesome/solid/comment-alt"
link: "https://discuss.colyseus.io"
- icon: "fontawesome/brands/github"
link: "https://github.com/colyseus"
- icon: "fontawesome/brands/twitter"
link: "https://twitter.com/colyseus"
- icon: "fontawesome/brands/discord"
link: "https://discord.gg/RY8rRS7"
# todo: upgrade to Google Analytics 4 (https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/?h=google+analytics#google-analytics)
analytics:
provider: google
property: UA-108278048-3
# Extensions
markdown_extensions:
- admonition
- pymdownx.highlight:
use_pygments: false
- codehilite:
linenums: False
guess_lang: False
- toc:
permalink: True
- markdown_fenced_code_tabs:
single_block_as_tab: False
active_class: "active"
template: "default"
- attr_list
# Nav menu
nav:
- "Colyseus | Framework":
- getting started:
- "colyseus/index.md"
- Client-side SDK:
- Installation:
- "Unity": "colyseus/getting-started/unity3d-client.md"
- "JavaScript": "colyseus/getting-started/javascript-client.md"
- "Defold Engine": "colyseus/getting-started/defold-client.md"
- "Haxe": "colyseus/getting-started/haxe-client.md"
- "Cocos Creator": "colyseus/getting-started/cocos-creator.md"
# - 'Cocos2d-x': 'getting-started/cocos2dx-client.md'
- "Construct3": "colyseus/getting-started/construct3-client.md"
- "Babylon.js Editor": "colyseus/getting-started/babylonjs-editor.md"
- "Usage": "colyseus/client/client.md"
- "Server API":
- "Server": "colyseus/server/api.md"
- "Room": "colyseus/server/room.md"
- "Timing events": "colyseus/server/timing-events.md"
- "Match-maker API": "colyseus/server/matchmaker.md"
- "Presence": "colyseus/server/presence.md"
- "Transport": "colyseus/server/transport.md"
- "Graceful shutdown": "colyseus/server/graceful-shutdown.md"
# - 'Custom State Serialization': 'server/state-serialization.md'
- "State Synchronization":
- "Overview": "colyseus/state/overview.md"
- "Schema": "colyseus/state/schema.md"
- "Best practices": "colyseus/best-practices/overview.md"
- "Built-in Rooms":
- "Lobby room": "colyseus/builtin-rooms/lobby.md"
- "Relay room": "colyseus/builtin-rooms/relay.md"
- "Tools":
- "Unit Testing": "colyseus/tools/unit-testing.md"
- "Monitoring Panel": "colyseus/tools/monitor.md"
- "Load Testing": "colyseus/tools/loadtest.md"
- "Authentication + Social": "colyseus/tools/colyseus-social.md"
- "Debugging": "colyseus/debugging.md"
- "Deployment": "colyseus/deployment.md"
- "Scalability": "colyseus/scalability.md"
- "How-to":
- "Customize room id": "colyseus/how-to/custom-room-id.md"
- "Password-protect a room": "colyseus/how-to/password-protect-room.md"
- "Deny a player joining a room": "colyseus/how-to/deny-player-join-a-room.md"
- "Rate-limit": "colyseus/how-to/rate-limit.md"
- "Setup server from scratch (TS)": "colyseus/how-to/setup-server-from-scratch-typescript.md"
- "Tech Demos":
- Unity:
- "Shooting Gallery": "colyseus/demo/shooting-gallery.md"
- "StarBoss": "colyseus/demo/starboss.md"
- "Tanks": "colyseus/demo/turn-based-tanks.md"
- "MMO": "colyseus/demo/mmo.md"
- Cocos Creator:
- "MMO": "colyseus/demo/cocos/mmo.md"
- Babylon.js Editor:
- "Hide and Seek": "colyseus/demo/babylonjs-editor/hide-and-seek.md"
- "Migrating":
- "0.14.18": "colyseus/migrating/0.14.18.md"
- "0.14": "colyseus/migrating/0.14.md"
- "0.13": "colyseus/migrating/0.13.md"
- "0.12": "colyseus/migrating/0.12.md"
- "0.11": "colyseus/migrating/0.11.md"
- "0.10": "colyseus/migrating/0.10.md"
- "0.9": "colyseus/migrating/0.9.md"
- "FAQ": "colyseus/faq.md"
- "Arena | Cloud Hosting":
- "arena/index.md"
- getting started:
# - Colyseus for Arena Cloud:
- "arena/getting-started/create-colyseus-server.md"
- "arena/getting-started/modify-colyseus-server.md"
- "arena/getting-started/create-application.md"
- "arena/getting-started/managing-application.md"
- Uploading Server Code:
- "arena/getting-started/upload-application.md"
- "arena/getting-started/upload-application-via-gitsync.md"
- "arena/getting-started/deploy-application.md"
- Managing Deployments:
- "arena/getting-started/managing-deployments.md"
- "arena/getting-started/deployment-logs.md"
- Reference:
- "arena/reference/npmrc-custom.md"
- "arena/reference/root-folder.md"
- "arena/reference/upload-application-via-gitsync.md"
- Application Deployments:
- "arena/production/deploy-prod-application.md"
- "arena/troubleshooting/troubleshoot.md"
- Add-on Services:
- "arena/addons/arena-servers-api.md"
- Public API:
- "arena/public-apis/index.md"
- getting started:
# - Colyseus for Arena Cloud:
- "arena/public-apis/getting-started/create-api-token.md"
- "arena/public-apis/getting-started/how-to-use.md"