[email protected]

## [1.0.0-pre.12] - 2022-01-24 ### Fixes * Clean up changelog for package promotion. ## [1.0.0-pre.11] - 2022-01-24 ### Changes * Updated to Burst 1.6.4. * Updated to Mathematics 1.2.5. * Documentation has been moved to the [offical multiplayer documentation site](https://docs-multiplayer.unity3d.com/transport/1.0.0/introduction). ### Fixes * Fixed a division by zero in `SimulatorPipelineStage` when `PacketDropInterval` is set. * Don't warn when receiving repeated connection accept messages (case 1370591). * Fixed an exception when receiving a data message from an unknown connection.
needle-mirror · Jan 24, 2022 · ee79f11 · ee79f11
1 parent c96ecc4
commit ee79f11
Show file tree

Hide file tree

Showing 58 changed files with 2,330 additions and 3,712 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,10 +1,28 @@
 # Change log
 
+## [1.0.0-pre.12] - 2022-01-24
+
+### Fixes
+* Clean up changelog for package promotion.
+
+## [1.0.0-pre.11] - 2022-01-24
+
+### Changes
+* Updated to Burst 1.6.4.
+* Updated to Mathematics 1.2.5.
+* Documentation has been moved to the [offical multiplayer documentation site](https://docs-multiplayer.unity3d.com/transport/1.0.0/introduction).
+
+### Fixes
+* Fixed a division by zero in `SimulatorPipelineStage` when `PacketDropInterval` is set.
+* Don't warn when receiving repeated connection accept messages (case 1370591).
+* Fixed an exception when receiving a data message from an unknown connection.
+
 ## [1.0.0-pre.10] - 2021-12-02
 
 ### Fixes
 * On fragmented and reliable pipelines, sending a large packet when the reliable window was almost full could result in the packet being lost.
 * Fixed "pending sends" warning being emitted very often when sending to remote hosts.
+* Revert decrease of MTU to 1384 on Xbox platforms (now back at 1400). It would cause issues for cross-platform communications.
 
 ## [1.0.0-pre.9] - 2021-11-26
 

diff --git a/Documentation~/TableOfContents.md b/Documentation~/TableOfContents.md
diff --git a/Documentation~/connection-state-machine.md b/Documentation~/connection-state-machine.md
diff --git a/Documentation~/event-consumption.md b/Documentation~/event-consumption.md
diff --git a/Documentation~/filter.yml b/Documentation~/filter.yml
@@ -0,0 +1,12 @@
+# https://dotnet.github.io/docfx/tutorial/howto_filter_out_unwanted_apis_attributes.html
+
+apiRules:
+  - exclude:
+    uidRegex: ^Unity.Networking.Transport.Tests.*$
+    type: Namespace
+  - exclude:
+    uidRegex: ^Unity.Networking.Editor.*$
+    type: Namespace
+  - exclude:
+    uidRegex: ^Unity.Networking.Transport.Samples.*$
+    type: Namespace
diff --git a/Documentation~/images/Pipeline-stages-diagram.png b/Documentation~/images/Pipeline-stages-diagram.png
diff --git a/Documentation~/images/com.unity.transport.connection.png b/Documentation~/images/com.unity.transport.connection.png
diff --git a/Documentation~/images/com.unity.transport.driver.png b/Documentation~/images/com.unity.transport.driver.png
diff --git a/Documentation~/images/console-view.PNG b/Documentation~/images/console-view.PNG
diff --git a/Documentation~/images/game-object.PNG b/Documentation~/images/game-object.PNG
diff --git a/Documentation~/images/inspector.PNG b/Documentation~/images/inspector.PNG
diff --git a/Documentation~/images/layercake.png b/Documentation~/images/layercake.png
diff --git a/Documentation~/index.md b/Documentation~/index.md
@@ -1,44 +1,24 @@
-# About Unity.Networking.Transport
+# About Unity Transport
 
-Use the `com.unity.transport` package to add multiplayer / network features to your project.
+The Unity Transport Package (`com.unity.transport`) is a low-level networking library geared towards multiplayer games development. It provides a connection-based abstraction layer over UDP sockets with optional functionality like reliability, ordering, and fragmentation.
 
-## Overview
+# Documentation
 
-![Transport Overview](images/layercake.png)
-
-# Installing Unity.Networking.Transport
-
-For installation instructions on the `com.unity.transport` package, follow the [installation guide](install.md).
-
-# Using Unity.Networking.Transport
-
-To learn how to use the `com.unity.transport` package in your own project, read the [manual](TableOfContents.md).
-
-> **Note**: Once you have installed the package, it is recommended that you read through the client and server workflows first.
+The full documentation for the package can be found on the [Unity multiplayer documentation site](https://docs-multiplayer.unity3d.com/transport/1.0.0/introduction).
 
 # Technical details
 
 ## Requirements
 
-This version of `com.unity.transport` is compatible with the following versions of the Unity Editor:
-
-* 2020.1.2 and later
-* All platforms supported by Unity are supported by the transport
-
-## Package contents
-
-The following table shows the package folder contents.
-
-|Location|Description|
-|---|---|
-|`Documentation`|Contains manual part of the documentation (script reference is inline using xmldoc).|
-|`Runtime`|Contains the implementation.|
-|`Tests`|Contains all the tests.|
+This version of `com.unity.transport` is compatible with the following Unity versions and platforms:
 
+* 2020.1.2 and later.
+* All platforms supported by Unity are supported, except WebGL.
 
 ## Document revision history
 
 |Date|Reason|
 |---|---|
+|Jan 24, 2022|Documentation moved to [multiplayer docs site](https://docs-multiplayer.unity3d.com/).|
 |Oct 22, 2018|Documentation reorganised and proofread by Technical Writer.|
 |Jul 18, 2018|Document created. Matches package version 0.1.0.|
diff --git a/Documentation~/install.md b/Documentation~/install.md