signal-fish-server 0.2.0

A lightweight, in-memory WebSocket signaling server for peer-to-peer game networking
Documentation 
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

site_name: Signal Fish Server
site_url: https://ambiguous-interactive.github.io/signal-fish-server/
site_description: A lightweight, zero-dependency WebSocket signaling server for peer-to-peer game networking
repo_url: https://github.com/Ambiguous-Interactive/signal-fish-server
repo_name: signal-fish-server
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - content.tabs.link
    - toc.follow
    - header.autohide
  icon:
    repo: fontawesome/brands/github
  font:
    text: Roboto
    code: Roboto Mono

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      auto_title: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
      permalink_title: Anchor link to this section
      toc_depth: 3
  - pymdownx.tasklist:
      custom_checkbox: true
  - abbr
  - def_list
  - footnotes
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.keys
  - pymdownx.smartsymbols
  - pymdownx.critic

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'

extra:
  generator: false

# Validation settings for strict mode.
# Internal-only docs (CI guides, hook references, etc.) are intentionally excluded from nav
# but contain links to files outside docs/ (e.g., .llm/skills/, tests/). These links are
# valid in the repo context but unresolvable by MkDocs. Downgrade to info to avoid blocking
# the build while keeping strict mode for our public documentation pages.
validation:
  nav:
    omitted_files: info
  links:
    not_found: info
    unrecognized_links: info

nav:
  - Home: index.md
  - Getting Started:
      - Quick Start: quickstart.md
      - Installation & Running: getting-started.md
  - Concepts:
      - What is Signal Fish?: concepts/overview.md
      - Rooms & Lobbies: concepts/rooms-and-lobbies.md
      - Authority System: concepts/authority.md
      - Reconnection: concepts/reconnection.md
      - Spectator Mode: concepts/spectator-mode.md
  - Guides:
      - Rust Client: guides/rust-client.md
  - Configuration:
      - Server Config: configuration.md
      - Authentication: authentication.md
      - Deployment: deployment.md
  - Reference:
      - Protocol Messages: protocol.md
      - Error Codes: reference/error-codes.md
      - Features: features.md
      - Architecture: architecture.md