新增FishNet文档

2026-09-20 15:53:11 +08:00
parent c403145db9
commit 179c282405
431 changed files with 15476 additions and 0 deletions
@@ -0,0 +1,8 @@
+---
+description: >-
+  Tutorials on how to convert Unity samples to support multiplayer using
+  FishNet.
+---
+
+# Unity Samples
+
@@ -0,0 +1,15 @@
+---
+description: >-
+  These tutorials will show you how to convert the third person starter assets
+  to support multiplayer.
+---
+
+# Starter Assets - Third Person
+
+<figure><img src="https://assetstorev1-prd-cdn.unity3d.com/key-image/421988f6-a827-428b-86d4-9b815f15cdce.webp" alt=""><figcaption></figcaption></figure>
+
+{% embed url="https://assetstore.unity.com/packages/essentials/starter-assets-thirdperson-updates-in-new-charactercontroller-pa-196526" %}
+
+### Client-authoritative or server-authoritative?
+
+We’ll demonstrate how to convert the asset using both methods. The **client-authoritative approach** is simpler to implement and offers players a smooth experience, but it carries the drawback of being more vulnerable to cheating. In contrast, the **server-authoritative approach** significantly reduces the risk of cheating, though it introduces higher input latency. This latency can be mitigated through **client-side prediction (CSP)**, which adds complexity but ensures responsiveness. The tutorial will guide you step by step through setting up CSP. However, before diving into the **server-authoritative + CSP tutorial**, it’s strongly recommended that you first review the [**Client-side Prediction guides**](../../../guides/features/prediction/what-is-client-side-prediction.md) to build a solid foundation.
@@ -0,0 +1,136 @@
+---
+description: >-
+  This tutorial shows how to make the third person starter asset multiplayer in
+  a client authoritative way.
+---
+
+# Client Authoritative
+
+{% stepper %}
+{% step %}
+### Before we begin
+
+Don't forget to import the third person starter asset into your project and ensure it's working correctly in your Unity version, input system, and rendering pipeline.
+{% endstep %}
+
+{% step %}
+### Import FishNet
+
+Let's begin by importing Fish-Networking. You can use the free or pro version for this tutorial, and you can get it from the GitHub, Asset Store, or Asset Package. See [installing-fish-networking.md](../../getting-started/installing-fish-networking.md "mention") for assistance with this step.
+{% endstep %}
+
+{% step %}
+### Create the NetworkManager
+
+With FishNet imported we can now get started with turning the singleplayer setup into a multiplayer one. Open up the **Playground** scene — or your own scene, if you already have one — and drag in the NetworkManager prefab from the `FishNet/Demos/Prefabs` folder.
+
+<figure><img src="../../../.gitbook/assets/add-networkmanager-to-playground.png" alt=""><figcaption></figcaption></figure>
+
+This will allow us to connect instances of the game to each other through the provided network HUD.
+{% endstep %}
+
+{% step %}
+### Prepare the player components
+
+Next, we’ll prepare the player object for network synchronization. Open the **PlayerArmature** prefab located in `Assets/StarterAssets/ThirdPersonController/Prefabs` and add the following components: **NetworkObject**, **NetworkTransform**, and **NetworkAnimator**.
+
+* **NetworkObject** links the prefab across the network.
+* **NetworkTransform** synchronizes its position and rotation.
+* **NetworkAnimator** ensures animations are synchronized.
+
+Together, these components enable the player to stay consistent across all connected clients. The default settings of these components should work, just ensure **Client Authoritative** is enabled on both the **NetworkTransform** and **NetworkAnimator**, the **Animator** field is set on the **NetworkAnimator**, and the **Component Configuration** field is set to _CharacterController_ in the **NetworkTransform**.
+
+<div><figure><img src="../../../.gitbook/assets/starter-assets-network-transform.png" alt=""><figcaption></figcaption></figure> <figure><img src="../../../.gitbook/assets/starter-assets-network-animator.png" alt=""><figcaption></figcaption></figure></div>
+{% endstep %}
+
+{% step %}
+### Setup the player code
+
+We now need to make sure the players can only move their own player objects. Open up the **ThirdPersonController** script and change it from inheriting from `MonoBehaviour` to `NetworkBehaviour` — this will require adding `using FishNet.Object;` to the top of your code.
+
+`public class ThirdPersonController : NetworkBehaviour`
+
+This code will allow us to make use of NetworkBehaviour properties, methods, and so on.
+
+With that done, we can add the following code to the top of the **Update** and **LateUpdate** methods:
+
+```csharp
+if (!IsOwner)
+    return;
+```
+
+This code will prevent the method from running on objects the player doesn't own, thus ensuring he can only move and control his own player.
+
+They should look like this now:
+
+```csharp
+private void Update()
+{
+    if (!IsOwner)
+        return;
+
+    _hasAnimator = TryGetComponent(out _animator);
+
+    JumpAndGravity();
+    GroundedCheck();
+    Move();
+}
+
+private void LateUpdate()
+{
+    if (!IsOwner)
+        return;
+
+    CameraRotation();
+}
+```
+{% endstep %}
+
+{% step %}
+### Set up the camera
+
+One thing we still need to do is tell the camera which player it should be following. We'll do that by instantiating a follow camera when our local player spawns in. Inside the **ThirdPersonController** script, add the following field:&#x20;
+
+```csharp
+[Tooltip("The Follow Camera prefab that we spawn for the owner")]
+public CinemachineVirtualCamera PlayerFollowCameraPrefab;
+```
+
+Then add this override method.
+
+```csharp
+public override void OnStartClient()
+{
+    if (!IsOwner)
+        return;
+
+    CinemachineVirtualCamera virtualCam = Instantiate(PlayerFollowCameraPrefab);
+    virtualCam.Follow = CinemachineCameraTarget.transform;
+}
+```
+{% endstep %}
+
+{% step %}
+### Set up the references
+
+Now we can delete the **PlayerFollowCamera** object from the scene and instead assign that prefab into our **PlayerArmature**'s _PlayerFollowCameraPrefab_ field.
+
+<figure><img src="../../../.gitbook/assets/starter-assets-playerfollowcamera.png" alt=""><figcaption></figcaption></figure>
+
+Finally, we will delete the **PlayerArmature** object from the scene and assign that prefab into our **NetworkManager**'s _PlayerPrefab_ field.
+
+<figure><img src="../../../.gitbook/assets/starter-assets-playerspawner.png" alt=""><figcaption></figcaption></figure>
+{% endstep %}
+
+{% step %}
+### Try it out!
+
+You are now ready to test your game. Launch multiple instances of it and start one as a server and client and the other/s as a client.
+
+<figure><img src="../../../.gitbook/assets/starter-assets-third-person-test.webp" alt=""><figcaption></figcaption></figure>
+
+{% hint style="info" %}
+You can launch a second Unity Editor instance by using [Unity's Multiplayer Play Mode](https://docs-multiplayer.unity3d.com/mppm/current/about/) package or a third-party package such as [ParrelSync](https://github.com/VeriorPies/ParrelSync?tab=readme-ov-file#parrelsync). Find out more about these options and how to use them with this tutorial: [testing-with-multiple-editors.md](../../simple/testing-with-multiple-editors.md "mention").
+{% endhint %}
+{% endstep %}
+{% endstepper %}
@@ -0,0 +1,7 @@
+---
+hidden: true
+---
+
+# Server Authoritative
+
+Under construction, stay tuned for updates!