Skip to content

Commit 3940aeb

Browse files
fernando-cortezjabbacakesVic-Cooperamanda-butler-unity
authored
feat: social hub doc page (#1373)
Co-authored-by: Amy Reeve <amy.reeve@unity3d.com> Co-authored-by: Vic Cooper <63712500+Vic-Cooper@users.noreply.github.com> Co-authored-by: amanda-butler-unity <96449283+amanda-butler-unity@users.noreply.github.com> Co-authored-by: Vic Cooper <vic.cooper@unity3d.com>
1 parent cdb8240 commit 3940aeb

File tree

4 files changed

+60
-4
lines changed

4 files changed

+60
-4
lines changed

docs/learn/bitesize/bitesize-introduction.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@ title: About Bitesize samples
66
The Bitesize Samples repository provides a series of sample code as modules to use in your games and better understand Netcode for GameObjects (Netcode).
77

88
* [Multiplayer Use Cases](bitesize-usecases.md) - Learn more about core Netcode For GameObjects (Netcode) features through practical examples and In-Editor tutorials.
9-
* [2D Space Shooter Sample](bitesize-spaceshooter.md) - Learn more about physics movement and status effects using Netcode `NetworkVariables` and `ObjectPooling`.
10-
* [Invaders Sample](bitesize-invaders.md) - Learn more about game flow, modes, unconventional movement networked, and a shared timer.
11-
* [Client Driven Sample](bitesize-clientdriven.md) - Learn more about Client driven movements, networked physics, spawning vs statically placed objects, object reparenting.
12-
* [Dynamic Addressables Network Prefabs](bitesize-dynamicprefabs.md) - Learn more about the dynamic prefab system, which allows us to add new spawnable prefabs at runtime.
9+
* [2D Space Shooter](bitesize-spaceshooter.md) - Learn more about physics movement and status effects using Netcode `NetworkVariables` and `ObjectPooling`.
10+
* [Invaders](bitesize-invaders.md) - Learn more about game flow, modes, unconventional movement networked, and a shared timer.
11+
* [Client Driven](bitesize-clientdriven.md) - Learn more about Client driven movements, networked physics, spawning vs statically placed objects, object reparenting.
12+
* [Dynamic Addressables Network Prefabs](bitesize-dynamicprefabs.md) - Learn more about the dynamic prefab system, which allows you to add new spawnable prefabs at runtime.
13+
* [Distributed Authority Social Hub](bitesize-socialhub.md) - Learn how to use features of distributed authority like host migration and NetworkObject ownership transfer.
1314

1415
## Requirements
1516

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
id: bitesize-socialhub
3+
title: Distributed Authority Social Hub sample
4+
description: Learn about the scenes in the Distributed Authority Social Hub sample.
5+
---
6+
7+
The [Distributed Authority Social Hub Sample](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize/tree/main/Basic/DistributedAuthoritySocialHub) is a project that demonstrates Distributed Authority's features and helps you integrate Distributed Authority into your own game projects.
8+
9+
Within Social Hub, you can explore Distributed Authority in a sandbox-like environment. You can:
10+
11+
- Automatically redistribute ownership of NetworkObjects across connected clients
12+
- Experience responsive gameplay through client-side NetworkObject spawning and deferred NetworkObject despawning
13+
- Transfer ownership of NetworkObjects with variable ownership flags
14+
- Host migration of a networked game session
15+
16+
## Prerequisites
17+
18+
Social Hub uses services from Unity Gaming Services to facilitate connectivity between players. To use these services inside your project, you must:
19+
20+
1. [Create an organization](https://support.unity.com/hc/en-us/articles/208592876-How-do-I-create-a-new-Unity-organization) inside the Unity Dashboard.
21+
2. Register your Unity project with that organization's cloud ID.
22+
23+
## The Bootstrap scene
24+
25+
This is the entry point to the sample. After the Bootstrap scene loads, the MainMenu scene appears.
26+
27+
**Note**: Be sure you have registered the project with a cloud ID.
28+
29+
## The MainMenu scene
30+
31+
To create or join an existing game:
32+
33+
1. Enter a player name and a session name.
34+
2. Select **Start**.
35+
36+
A successful load indicates that you have correctly registered your project with a cloud ID.
37+
38+
## The HubScene_TownMarket scene
39+
40+
This a sandbox-like environment that supports 64 players. The control model is WASD controls. Move around the level with client-authority, and use **E** to interact with crates and pots. These are NetworkObjects that you can pick up, drop, and throw. Attach one NetworkObject to another with an animated rig through the use of FixedJoints. As a client picks up a NetworkObject, authority of that NetworkObject transfers to that client.
41+
42+
A client has authority over its player NetworkObject. Therefore, the movement, animations, and interactions that a client performs are client-authoritative.
43+
44+
This sample inherently supports host migration out of the box. Load multiple clients, and witness the automatic distribution of ownership of NetworkObjects when the original session owner leaves the session.
45+
46+
## Additional resources
47+
48+
- Get help and ask questions on [Multiplayer Discussions](https://discussions.unity.com/lists/multiplayer).
49+
- Join the community of Multiplayer creators on the [Multiplayer Networking Discord](https://discord.gg/unity-multiplayer-network).
50+
- [Request a feature or report a bug](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize/issues/new/choose).

docs/terms-concepts/distributed-authority.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,4 @@ For more information about how distributed authority works in Netcode for GameOb
5050
- [Race conditions](../basics/race-conditions.md)
5151
- [Spawning synchronization](../basics/spawning-synchronization.md)
5252
- [Deferred despawning](../basics/deferred-despawning.md)
53+
- [Distributed Authority Social Hub sample](../learn/bitesize/bitesize-socialhub.md)

sidebars.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -578,6 +578,10 @@ module.exports = {
578578
"type": "doc",
579579
"id": "learn/bitesize/bitesize-dynamicPrefabs"
580580
},
581+
{
582+
"type": "doc",
583+
"id": "learn/bitesize/bitesize-socialhub"
584+
},
581585
]
582586
},
583587
{

0 commit comments

Comments
 (0)