Skip to content

Improve clarity in networking documentation #12408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
skyace65 merged 5 commits into from
Sep 30, 2026
+5 −3
Merged

Improve clarity in networking documentation #12408

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
da0afc8
Improve clarity in networking documentation
mdeiana Sep 25, 2026
a4ed9c2
Update tutorials/networking/high_level_multiplayer.rst
mdeiana Sep 25, 2026
58f2129
Update tutorials/networking/high_level_multiplayer.rst
mdeiana Sep 25, 2026
b669fcd
Update tutorials/networking/high_level_multiplayer.rst
mdeiana Sep 25, 2026
5108ad2
Remove trailing whitespace
Calinou Sep 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions tutorials/networking/high_level_multiplayer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Hosting considerations
When hosting a server, clients on your :abbr:`LAN (Local Area Network)` can
connect using the internal IP address which is usually of the form
``192.168.*.*``. This internal IP address is **not** reachable by
non-LAN/Internet clients.
clients outside the LAN, such as ones that need to connect via the Internet.

On Windows, you can find your internal IP address by opening a command prompt
and entering ``ipconfig``. On macOS, open a Terminal and enter ``ifconfig``. On
Expand Down Expand Up @@ -173,8 +173,10 @@ Every peer is assigned a unique ID. The server's ID is always 1, and clients are

Responding to connections or disconnections is possible by connecting to ``MultiplayerAPI``'s signals:

- ``peer_connected(id: int)`` This signal is emitted with the newly connected peer's ID on each other peer, and on the new peer multiple times, once with each other peer's ID.
- ``peer_disconnected(id: int)`` This signal is emitted on every remaining peer when one disconnects.
- ``peer_connected(id: int)`` This signal is emitted on all existing peers with ``id`` corresponding to the ID of the newly connected peer.
It is also emitted on the new peer once for each existing peer, each time with ``id`` corresponding to that peer's ID.
- ``peer_disconnected(id: int)`` This signal is emitted on every remaining peer when one disconnects, with ``id`` corresponding to the ID
of the disconnected peer.

The rest are only emitted on clients:

Expand Down
Loading