238 lines
18 KiB
Markdown
238 lines
18 KiB
Markdown
# Table of contents
|
|
|
|
## Overview
|
|
|
|
* [What Is FishNet?](README.md)
|
|
* [Features](overview/readme/features/README.md)
|
|
* [Unity Compatibility](overview/readme/features/unity-compatibility.md)
|
|
* [Performance](overview/readme/features/performance/README.md)
|
|
* [Benchmark Setup](overview/readme/features/performance/benchmark-setup.md)
|
|
* [Fish-Networking vs Mirror](overview/readme/features/performance/fish-networking-vs-mirror.md)
|
|
* [Pro, Projects, and Support](overview/readme/pro-projects-and-support.md)
|
|
* [Business Support](overview/readme/business-support.md)
|
|
* [Development](overview/readme/development/README.md)
|
|
* [Changelog](https://github.com/FirstGearGames/FishNet/releases)
|
|
* [Roadmap](https://trello.com/b/Gmvv1bgf/fish-networking-official-road-map)
|
|
* [Branding](overview/readme/branding.md)
|
|
* [Legal Restrictions](overview/readme/legal-restrictions.md)
|
|
* [Showcase](overview/showcase/README.md)
|
|
* [Upcoming Releases](overview/showcase/upcoming-releases.md)
|
|
* [Asset Integrations](overview/asset-integrations.md)
|
|
* [Community Resources](overview/community-resources.md)
|
|
|
|
## Tutorials
|
|
|
|
* [Getting Started](tutorials/getting-started/README.md)
|
|
* [Installing Fish-Networking](tutorials/getting-started/installing-fish-networking.md)
|
|
* [Getting Connected](tutorials/getting-started/getting-connected.md)
|
|
* [Preparing Your Player](tutorials/getting-started/preparing-your-player.md)
|
|
* [Moving Your Player Around](tutorials/getting-started/moving-your-player-around.md)
|
|
* [Spawning and Despawning Items](tutorials/getting-started/spawning-and-despawning-items.md)
|
|
* [Using SyncVars to Sync Colors](tutorials/getting-started/using-syncvars-to-sync-colors.md)
|
|
* [Setting Up a Camera](tutorials/getting-started/setting-up-a-camera/README.md)
|
|
* [Instantiating a Local Camera](tutorials/getting-started/setting-up-a-camera/instantiating-a-local-camera.md)
|
|
* [Using the Scene Camera](tutorials/getting-started/setting-up-a-camera/using-the-scene-camera.md)
|
|
* [Basic Setup with Cinemachine](tutorials/getting-started/setting-up-a-camera/basic-setup-with-cinemachine.md)
|
|
* [Connecting to Remote Devices](tutorials/getting-started/connecting-to-remote-devices.md)
|
|
* [Beyond the Basics](tutorials/getting-started/commonly-used-guides.md)
|
|
* [Common Tasks](tutorials/simple/README.md)
|
|
* [Starting FishNet's Connections](tutorials/simple/starting-fishnets-connections.md)
|
|
* [Making a Custom Player Spawner](tutorials/simple/making-a-custom-player-spawner/README.md)
|
|
* [Spawning Players Manually](tutorials/simple/making-a-custom-player-spawner/manually.md)
|
|
* [Spawning Selected Player](tutorials/simple/making-a-custom-player-spawner/spawning-selected-player.md)
|
|
* [Spawning Players When Set Number of Players Joined](tutorials/simple/making-a-custom-player-spawner/set-player-number.md)
|
|
* [Spawning Players on Scene Load](tutorials/simple/making-a-custom-player-spawner/on-scene-load.md)
|
|
* [Making a Loading Screen](tutorials/simple/making-a-loading-screen.md)
|
|
* [Testing with Multiple Editors](tutorials/simple/testing-with-multiple-editors.md)
|
|
* [Simulating Bad Network Connections](tutorials/simple/simulating-bad-network-connections.md)
|
|
* [Building a Dedicated Server](tutorials/simple/building-a-dedicated-server.md)
|
|
* [Unity Samples](tutorials/unity-samples/README.md)
|
|
* [Starter Assets - Third Person](tutorials/unity-samples/starter-assets-third-person/README.md)
|
|
* [Client Authoritative](tutorials/unity-samples/starter-assets-third-person/client-authoritative.md)
|
|
* [Server Authoritative](tutorials/unity-samples/starter-assets-third-person/server-authoritative.md)
|
|
* [Complete Games](tutorials/complete-games.md)
|
|
|
|
## Guides
|
|
|
|
* [High-Level Overview](guides/high-level-overview/README.md)
|
|
* [Fundamentals](guides/high-level-overview/fundamentals.md)
|
|
* [Networking Models](guides/high-level-overview/networking-models.md)
|
|
* [Terminology](guides/high-level-overview/terminology/README.md)
|
|
* [Server, Client, Host](guides/high-level-overview/terminology/server-client-host.md)
|
|
* [Communicating](guides/high-level-overview/terminology/communicating.md)
|
|
* [Miscellaneous](guides/high-level-overview/terminology/miscellaneous.md)
|
|
* [Transports](guides/high-level-overview/transports.md)
|
|
* [Features](guides/features/README.md)
|
|
* [Server and Client Identification](guides/features/server-and-client-identification/README.md)
|
|
* [Executing on Server or Client](guides/features/server-and-client-identification/executing-on-server-or-client.md)
|
|
* [NetworkConnections](guides/features/server-and-client-identification/networkconnections.md)
|
|
* [Networked GameObjects and Scripts](guides/features/networked-gameobjects-and-scripts/README.md)
|
|
* [NetworkObjects](guides/features/networked-gameobjects-and-scripts/networkobjects/README.md)
|
|
* [Nested NetworkObjects](guides/features/networked-gameobjects-and-scripts/networkobjects/nested-networkobjects.md)
|
|
* [NetworkBehaviour](guides/features/networked-gameobjects-and-scripts/network-behaviour-guides.md)
|
|
* [Spawning and Despawning](guides/features/networked-gameobjects-and-scripts/spawning/README.md)
|
|
* [Spawn Payloads](guides/features/networked-gameobjects-and-scripts/spawning/spawn-payloads.md)
|
|
* [Predicted Spawning](guides/features/networked-gameobjects-and-scripts/spawning/predicted-spawning.md)
|
|
* [Object Pooling](guides/features/networked-gameobjects-and-scripts/spawning/object-pooling.md)
|
|
* [Network State Events](guides/features/network-callbacks.md)
|
|
* [Network Communication](guides/features/network-communication/README.md)
|
|
* [Remote Procedure Calls](guides/features/network-communication/remote-procedure-calls.md)
|
|
* [SyncTypes](guides/features/network-communication/synchronizing/README.md)
|
|
* [Customizing Behavior](guides/features/network-communication/synchronizing/customizing-behavior.md)
|
|
* [SyncVar](guides/features/network-communication/synchronizing/syncvar.md)
|
|
* [SyncList](guides/features/network-communication/synchronizing/synclist.md)
|
|
* [SyncHashSet](guides/features/network-communication/synchronizing/synchashset.md)
|
|
* [SyncDictionary](guides/features/network-communication/synchronizing/syncdictionary.md)
|
|
* [SyncTimer](guides/features/network-communication/synchronizing/synctimer.md)
|
|
* [SyncStopwatch](guides/features/network-communication/synchronizing/syncstopwatch.md)
|
|
* [Custom SyncType](guides/features/network-communication/synchronizing/custom-synctype.md)
|
|
* [Broadcasts](guides/features/network-communication/broadcasts.md)
|
|
* [Data Serialization](guides/features/data-serialization/README.md)
|
|
* [Custom Serializers](guides/features/data-serialization/custom-serializers-guides/README.md)
|
|
* [Interface Serializers](guides/features/data-serialization/custom-serializers-guides/interface-serializers.md)
|
|
* [Inheritance Serializers](guides/features/data-serialization/custom-serializers-guides/inheritance-serializers.md)
|
|
* [Ownership](guides/features/ownership/README.md)
|
|
* [Using Ownership to Read Values](guides/features/ownership/using-ownership-to-read-values.md)
|
|
* [Area of Interest (Observer System)](guides/features/observers/README.md)
|
|
* [Modifying Conditions](guides/features/observers/modifying-conditions.md)
|
|
* [Custom Conditions](guides/features/observers/custom-conditions.md)
|
|
* [Scene Management](guides/features/scene-management/README.md)
|
|
* [Scene Events](guides/features/scene-management/scene-events.md)
|
|
* [Scene Data](guides/features/scene-management/scene-data/README.md)
|
|
* [SceneLookupData](guides/features/scene-management/scene-data/scenelookupdata.md)
|
|
* [SceneLoadData](guides/features/scene-management/scene-data/sceneloaddata.md)
|
|
* [SceneUnloadData](guides/features/scene-management/scene-data/sceneunloaddata.md)
|
|
* [Loading Scenes](guides/features/scene-management/loading-scenes/README.md)
|
|
* [Automatic Online and Offline Scenes](guides/features/scene-management/loading-scenes/automatic-online-and-offline-scenes.md)
|
|
* [Unloading Scenes](guides/features/scene-management/unloading-scenes.md)
|
|
* [Scene Stacking](guides/features/scene-management/scene-stacking.md)
|
|
* [Scene Caching](guides/features/scene-management/scene-caching.md)
|
|
* [Scene Visibility](guides/features/scene-management/scene-visibility.md)
|
|
* [Persisting NetworkObjects](guides/features/scene-management/persisting-networkobjects.md)
|
|
* [Custom Scene Processors](guides/features/scene-management/custom-scene-processors/README.md)
|
|
* [Addressables](guides/features/scene-management/custom-scene-processors/addressables.md)
|
|
* [InstanceFinder](guides/features/instancefinder-guides.md)
|
|
* [Addressables](guides/features/addressables.md)
|
|
* [Transports](guides/features/transports/README.md)
|
|
* [Multipass](guides/features/transports/multipass.md)
|
|
* [Prediction](guides/features/prediction/README.md)
|
|
* [What Is Client-Side Prediction](guides/features/prediction/what-is-client-side-prediction.md)
|
|
* [Configuring PredictionManager](guides/features/prediction/configuring-predictionmanager.md)
|
|
* [Configuring TimeManager](guides/features/prediction/configuring-timemanager.md)
|
|
* [Configuring NetworkObject](guides/features/prediction/configuring-networkobject.md)
|
|
* [Offline Rigidbodies](guides/features/prediction/offline-rigidbodies.md)
|
|
* [Interpolations](guides/features/prediction/interpolations.md)
|
|
* [Creating Code](guides/features/prediction/creating-code/README.md)
|
|
* [Controlling an Object](guides/features/prediction/creating-code/controlling-an-object.md)
|
|
* [Non-Controlled Object](guides/features/prediction/creating-code/non-controlled-object.md)
|
|
* [Understanding ReplicateState](guides/features/prediction/creating-code/understanding-replicatestate/README.md)
|
|
* [Using States in Code](guides/features/prediction/creating-code/understanding-replicatestate/using-states-in-code.md)
|
|
* [Predicting States in Code](guides/features/prediction/creating-code/understanding-replicatestate/predicting-states-in-code.md)
|
|
* [Advanced Controls](guides/features/prediction/creating-code/advanced-controls.md)
|
|
* [Custom Comparers](guides/features/prediction/custom-comparers.md)
|
|
* [PredictionRigidbody](guides/features/prediction/predictionrigidbody.md)
|
|
* [Using NetworkColliders](guides/features/prediction/using-networkcolliders.md)
|
|
* [Lag Compensation](guides/features/lag-compensation/README.md)
|
|
* [States](guides/features/lag-compensation/states.md)
|
|
* [Raycast](guides/features/lag-compensation/raycast.md)
|
|
* [Projectiles](guides/features/lag-compensation/projectiles.md)
|
|
* [Code Stripping (Pro Feature)](guides/features/code-stripping.md)
|
|
* [Level of Detail (Pro Feature)](guides/features/level-of-detail.md)
|
|
* [Demos](guides/demos.md)
|
|
* [Updating FishNet](guides/updating-fishnet/README.md)
|
|
* [Changes in API](guides/updating-fishnet/upgrading-api.md)
|
|
* [Upgrading to FishNet Pro](guides/updating-fishnet/upgrading-to-fishnet-pro.md)
|
|
* [Server Hosting](guides/server-hosting/README.md)
|
|
* [Terminology](guides/server-hosting/terminology.md)
|
|
* [Services](guides/server-hosting/services/README.md)
|
|
* [PlayFlow Cloud (Recommended)](guides/server-hosting/services/playflow-cloud/README.md)
|
|
* [Getting Started with PlayFlow](guides/server-hosting/services/playflow-cloud/getting-started-with-playflow.md)
|
|
* [Easy WebGL Hosting with PlayFlow](guides/server-hosting/services/playflow-cloud/easy-webgl-hosting-with-playflow.md)
|
|
* [Getting Started with AWS](guides/server-hosting/services/getting-started-with-aws.md)
|
|
* [Moving to Fish-Networking](guides/upgrading-to-fish-net.md)
|
|
* [Troubleshooting](guides/troubleshooting/README.md)
|
|
* [Technical Limitations](guides/troubleshooting/technical-limitations.md)
|
|
* [Creating Bug Reports](guides/troubleshooting/creating-bug-reports/README.md)
|
|
* [Report Example](guides/troubleshooting/creating-bug-reports/report-example.md)
|
|
* [FAQ](guides/troubleshooting/frequently-asked-questions-faq.md)
|
|
|
|
## FishNet Building Blocks
|
|
|
|
* [Components](fishnet-building-blocks/components/README.md)
|
|
* [Managers](fishnet-building-blocks/components/managers/README.md)
|
|
* [NetworkManager](fishnet-building-blocks/components/managers/network-manager.md)
|
|
* [TimeManager](fishnet-building-blocks/components/managers/time-manager.md)
|
|
* [PredictionManager](fishnet-building-blocks/components/managers/predictionmanager.md)
|
|
* [ServerManager](fishnet-building-blocks/components/managers/server-manager.md)
|
|
* [ClientManager](fishnet-building-blocks/components/managers/clientmanager.md)
|
|
* [SceneManager](fishnet-building-blocks/components/managers/scenemanager.md)
|
|
* [TransportManager](fishnet-building-blocks/components/managers/transportmanager/README.md)
|
|
* [IntermediateLayer](fishnet-building-blocks/components/managers/transportmanager/intermediatelayer.md)
|
|
* [StatisticsManager](fishnet-building-blocks/components/managers/statisticsmanager.md)
|
|
* [ObserverManager](fishnet-building-blocks/components/managers/observermanager/README.md)
|
|
* [HashGrid](fishnet-building-blocks/components/managers/observermanager/hashgrid.md)
|
|
* [RollbackManager (Pro Feature)](fishnet-building-blocks/components/managers/rollbackmanager-pro-feature.md)
|
|
* [DebugManager](fishnet-building-blocks/components/managers/debugmanager.md)
|
|
* [Prediction](fishnet-building-blocks/components/prediction/README.md)
|
|
* [Network Collider](fishnet-building-blocks/components/prediction/network-collider/README.md)
|
|
* [NetworkCollision](fishnet-building-blocks/components/prediction/network-collider/networkcollision.md)
|
|
* [NetworkCollision2D](fishnet-building-blocks/components/prediction/network-collider/networkcollision2d.md)
|
|
* [NetworkTrigger](fishnet-building-blocks/components/prediction/network-collider/networktrigger.md)
|
|
* [NetworkTrigger2D](fishnet-building-blocks/components/prediction/network-collider/networktrigger2d.md)
|
|
* [OfflineRigidbody](fishnet-building-blocks/components/prediction/offlinerigidbody.md)
|
|
* [PredictedOwner](fishnet-building-blocks/components/prediction/predictedowner.md)
|
|
* [PredictedSpawn](fishnet-building-blocks/components/prediction/predictedspawn.md)
|
|
* [Utilities](fishnet-building-blocks/components/utilities/README.md)
|
|
* [PingDisplay](fishnet-building-blocks/components/utilities/pingdisplay.md)
|
|
* [BandwidthDisplay](fishnet-building-blocks/components/utilities/bandwidthdisplay.md)
|
|
* [Authenticator](fishnet-building-blocks/components/utilities/authenticator.md)
|
|
* [Tick Smoothers](fishnet-building-blocks/components/tick-smoothers/README.md)
|
|
* [NetworkTickSmoother](fishnet-building-blocks/components/tick-smoothers/networkticksmoother.md)
|
|
* [OfflineTickSmoother](fishnet-building-blocks/components/tick-smoothers/offlineticksmoother.md)
|
|
* [MonoTickSmoother \[Obsolete\]](fishnet-building-blocks/components/tick-smoothers/monoticksmoother-obsolete.md)
|
|
* [DetachableNetworkTickSmoother \[Obsolete\]](fishnet-building-blocks/components/tick-smoothers/detachablenetworkticksmoother-obsolete.md)
|
|
* [NetworkObject](fishnet-building-blocks/components/network-object.md)
|
|
* [NetworkBehaviour](fishnet-building-blocks/components/network-behaviour-components/README.md)
|
|
* [TickNetworkBehaviour](fishnet-building-blocks/components/network-behaviour-components/ticknetworkbehaviour.md)
|
|
* [NetworkTransform](fishnet-building-blocks/components/network-transform.md)
|
|
* [NetworkAnimator](fishnet-building-blocks/components/networkanimator.md)
|
|
* [NetworkObserver](fishnet-building-blocks/components/network-observer.md)
|
|
* [DefaultScene](fishnet-building-blocks/components/utilities/defaultscene.md)
|
|
* [PlayerSpawner](fishnet-building-blocks/components/playerspawner.md)
|
|
* [ServerSpawner](fishnet-building-blocks/components/serverspawner.md)
|
|
* [ColliderRollback (Pro Feature)](fishnet-building-blocks/components/colliderrollback.md)
|
|
* [Prefabs](fishnet-building-blocks/prefabs/README.md)
|
|
* [NetworkManager](fishnet-building-blocks/prefabs/networkmanager.md)
|
|
* [NetworkHudCanvas](fishnet-building-blocks/prefabs/networkhudcanvas.md)
|
|
* [ScriptableObjects](fishnet-building-blocks/scriptableobjects/README.md)
|
|
* [ObserverConditions](fishnet-building-blocks/scriptableobjects/observerconditions/README.md)
|
|
* [DistanceCondition](fishnet-building-blocks/scriptableobjects/observerconditions/distancecondition.md)
|
|
* [GridCondition](fishnet-building-blocks/scriptableobjects/observerconditions/gridcondition.md)
|
|
* [HostOnlyCondition](fishnet-building-blocks/scriptableobjects/observerconditions/hostonlycondition.md)
|
|
* [MatchCondition](fishnet-building-blocks/scriptableobjects/observerconditions/matchcondition.md)
|
|
* [OwnerOnlyCondition](fishnet-building-blocks/scriptableobjects/observerconditions/owneronlycondition.md)
|
|
* [SceneCondition](fishnet-building-blocks/scriptableobjects/observerconditions/scenecondition.md)
|
|
* [SpawnablePrefabs](fishnet-building-blocks/scriptableobjects/spawnableprefabs/README.md)
|
|
* [DefaultPrefabObjects](fishnet-building-blocks/scriptableobjects/spawnableprefabs/defaultprefabobjects.md)
|
|
* [SinglePrefabObjects](fishnet-building-blocks/scriptableobjects/spawnableprefabs/singleprefabobjects.md)
|
|
* [DualPrefabObjects](fishnet-building-blocks/scriptableobjects/spawnableprefabs/dualprefabobjects.md)
|
|
* [LevelLoggingConfiguration](fishnet-building-blocks/scriptableobjects/levelloggingconfiguration.md)
|
|
* [Transports](fishnet-building-blocks/transports/README.md)
|
|
* [Tugboat](fishnet-building-blocks/transports/tugboat.md)
|
|
* [Multipass](fishnet-building-blocks/transports/multipass.md)
|
|
* [Yak (Pro Feature)](fishnet-building-blocks/transports/yak-pro-feature.md)
|
|
* [Bayou](fishnet-building-blocks/transports/bayou.md)
|
|
* [FishyWebRTC](fishnet-building-blocks/transports/fishywebrtc.md)
|
|
* [Canoe WebRTC](fishnet-building-blocks/transports/canoe-webrtc.md)
|
|
* [Blitz Relay for FishNet](fishnet-building-blocks/transports/fishyblitzrelay.md)
|
|
* [FishyUnityTransport](fishnet-building-blocks/transports/fishyunitytransport.md)
|
|
* [FishySteamworks (Steam)](fishnet-building-blocks/transports/fishysteamworks.md)
|
|
* [FishyEOS (Epic Online Services)](fishnet-building-blocks/transports/fishyeos-epic-online-services.md)
|
|
* [FishyFacepunch (Steam)](fishnet-building-blocks/transports/fishyfacepunch-steam.md)
|
|
* [FishyRealtime (Photon)](fishnet-building-blocks/transports/fishyrealtime.md)
|
|
* [Configuration and Tools](fishnet-building-blocks/configuration-and-tools.md)
|
|
|
|
## API Documentation
|
|
|
|
* [API Reference](https://fish-networking.com/FishNet/api/api/index.html)
|