Commit Graph

299 Commits

Author SHA1 Message Date
FirstGearGames
5dbb1709a8
Added video tutorial link. 2019-12-16 16:56:44 -05:00
FirstGearGames
193c1068bd
Added video tutorial link. 2019-12-16 16:55:54 -05:00
FirstGearGames
beca3dfd20
Added SyncVar hook video link. 2019-12-16 16:51:53 -05:00
FirstGearGames
0cabfff9c8
Changedvideo link to video within playlist. 2019-12-16 16:49:34 -05:00
FirstGearGames
c51b27eb2f
Added video tutorial. 2019-12-16 16:48:10 -05:00
FirstGearGames
3cb4f93790
Added missing field setter on Item ReadItem() for ARMOR. 2019-12-16 15:33:12 -05:00
MrGadget
3b1e6dcc6f
Update SpawnPlayerCustom.md 2019-12-15 18:56:38 -05:00
Paul Pacheco
3e1d0bd147 doc: Improved alt for video tutorial 2019-12-14 14:16:07 -06:00
Paul Pacheco
39c934af54 docs:Use video tutorial image 2019-12-14 13:50:35 -06:00
FirstGearGames
3033ed7541 docs: Added video tutorial URL (#1308)
* Update SyncVars.md

* Update doc/Guides/Sync/SyncVars.md

Co-Authored-By: Paul Pacheco <paulpach@gmail.com>

* Update SyncVars.md

- Removed starting time from video URL.

* Resize image and move to the top

* Make video bigger
2019-12-14 10:23:52 -06:00
MrGadget
f21dbfee01
Update Migration.md 2019-12-14 01:02:33 -05:00
MrGadget
6eb88a9c2c
Update ChangeLog.md 2019-12-12 23:10:19 -05:00
Paul Pacheco
15185de56f docs: include Components in the generated docs
fixes #1218
2019-12-12 20:36:08 -06:00
MrGadget
c2d8cdfbcd
Update ChangeLog.md 2019-12-09 20:59:02 -05:00
MrGadget
d4ac60fcfd
Update ChangeLog.md 2019-12-09 20:58:16 -05:00
Robin Gustafsson
a8795b3449 Fix spelling mistakes 2019-12-07 23:31:48 +01:00
MrGadget
424a417e35
Update ChangeLog.md 2019-12-05 21:17:29 -05:00
MrGadget
9855c1dbdb
Update ChangeLog.md 2019-12-05 21:17:13 -05:00
Chris Langsenkamp
05dd3b6660 Updated DataTypes doc 2019-12-04 16:07:28 -05:00
Chris Langsenkamp
9852fef846 Doc updates 2019-12-03 14:42:38 -05:00
vis2k
13e2dcccd9
breaking: SyncList.Callback passes old and new entries instead of only passing one entry which is sometimes the old, sometimes the new entry. This is more consistent and it's very useful to know the previous value in a hook for OP_SET and OP_DIRTY. (#1273)
* feature: SyncList.Callback passes old and new entries instead of only passing one entry which is sometimes the old, sometimes the new entry. This is more consistent and it's very useful to know the previous value in a hook for OP_SET and OP_DIRTY.

* update tests

* update docs
2019-12-03 08:35:41 +01:00
Paul Pacheco
706fc23127 docs: explain what sync to owner does 2019-11-28 10:20:29 -06:00
Paul Pacheco
f5e2fd49ff docs: suggest custom data types instead of overriding OnSerialize 2019-11-28 10:01:44 -06:00
Paul Pacheco
2bb65a6f64 add link to video tutorial in Getting started 2019-11-28 09:29:29 -06:00
Chris Langsenkamp
ca0ec5e36c Doc formatting 2019-11-27 21:48:41 -05:00
Paul Pacheco
f24c4deb74 docs: document how inheritance works with data types 2019-11-27 20:01:06 -06:00
Paul Pacheco
e02200c5fa docs: document how inheritance works with syncvars 2019-11-27 19:30:43 -06:00
gestewa
2f1458f3ff
Update index.md
Typo found in documentation, OnDeSerialize -> OnDeserialize
2019-11-24 13:59:17 -08:00
Paul Pacheco
aa9e9efa67 docs: fix changelog link 2019-11-23 11:03:24 +09:00
Paul Pacheco
3a72507878 docs: Enable global search 2019-11-23 11:03:21 +09:00
MrGadget
d85ae85ddf Update index.md 2019-11-23 11:03:05 +09:00
MrGadget
76bdbc88e7 Update index.md 2019-11-23 11:03:00 +09:00
MrGadget
24037b8803 Update Migration.md 2019-11-23 11:02:58 +09:00
MrGadget
e7b6a52cbb Update ChangeLog.md 2019-11-23 11:02:55 +09:00
MrGadget
0f49883874 Update ChangeLog.md 2019-11-23 11:02:11 +09:00
MrGadget
d829a0be3b Update ChangeLog.md 2019-11-23 11:01:13 +09:00
MrGadget
5c050aff8e Update ChangeLog.md 2019-11-23 10:59:46 +09:00
Chris Langsenkamp
a19b5d5a58 Replaced doc images 2019-11-23 10:58:08 +09:00
Chris Langsenkamp
6d9a12a026 Updated doc images 2019-11-23 10:58:06 +09:00
Chris Langsenkamp
1ca8bcea54 Updated NetworkIdentity doc 2019-11-23 10:58:02 +09:00
Chris Langsenkamp
2fdc224f43 update code example 2019-11-23 10:57:22 +09:00
Paul Pacheco
31ea2345cc doc: clarify ownership as seen in NetworkBehaviours 2019-11-23 10:56:34 +09:00
Chris Langsenkamp
890676fd84 Updated ChangeLog 2019-11-23 10:56:17 +09:00
vis2k
589f62dee3 Doc favicon file 2019-11-23 10:54:01 +09:00
vis2k
3735ea5e8c Doc color consistency 2019-11-23 10:53:59 +09:00
Chris Langsenkamp
033e7972f9 Doc Update 2019-11-23 10:53:56 +09:00
Paul Pacheco
a2f98d03b0 Improve authority docs (#1207) 2019-11-23 10:53:52 +09:00
Chris Langsenkamp
6551332e1b Updated changelog 2019-11-23 10:52:34 +09:00
MrGadget
b9653f3f19
Update ChangeLog.md 2019-11-03 10:52:58 -05:00
vis2k
188b74edd6
Fallback Transport (#1198)
* Fallback Transport

* doc

* doc

* help URL

* exception

* fixed help url
2019-11-03 00:04:59 +01:00
MrGadget
2795b81e97
Moved enum 2019-11-02 01:49:46 -04:00
Paul Pacheco
d6f07cd8ac docs: it is safe to update a syncvar inside it's hook 2019-10-27 10:18:15 -05:00
vis2k
12c5a8fdc3 Revert "feat: Add Timeout to NetworkAuthenticator (#1091)"
This reverts commit e8cc9ba27b.
2019-10-20 20:12:14 +02:00
MrGadget
e8cc9ba27b feat: Add Timeout to NetworkAuthenticator (#1091)
* Add timeout to NetworkAuthenticator

* Added back the using Vis removed

* updated doc

* Typo
2019-10-20 11:23:34 -05:00
Chris Langsenkamp
9806e77718 Fixed typo 2019-10-19 23:45:52 -04:00
Chris Langsenkamp
0024353d44 Merge branch 'master' of https://github.com/vis2k/Mirror 2019-10-13 13:41:53 -04:00
Chris Langsenkamp
caa9a4db95 Updated doc code sample 2019-10-13 13:41:46 -04:00
Paul Pacheco
0466bc5c81 Update profiler screenshot for version 1.4 2019-10-13 12:07:28 -05:00
Chris Langsenkamp
bb48c50caa Merge branch 'master' of https://github.com/vis2k/Mirror 2019-10-13 12:35:00 -04:00
Chris Langsenkamp
248d042360 updated doc code sample 2019-10-13 12:34:46 -04:00
Paul Pacheco
64b7597aec Update docs for profiler version 1.3 2019-10-12 17:09:32 -05:00
Chris Langsenkamp
edbc2dc847 Fixed typo and formatting 2019-10-11 18:10:13 -04:00
MichalPetryka
2337cb2037 Data types documentatation recommends structs to be readonly and implement IEquatable. (#1138) 2019-10-06 14:45:17 -05:00
Chris Langsenkamp
8aebfdec1a Added Basic image 2019-10-04 04:49:28 -04:00
Chris Langsenkamp
26c23f7115 Restructured Examples docs with images 2019-10-04 04:21:02 -04:00
Chris Langsenkamp
5de4e4bf30 Updated Changelog 2019-10-03 09:05:16 -04:00
Chris Langsenkamp
c6251bc15b SyncVar Limit is 64 per NetworkBehaviour 2019-10-03 08:13:39 -04:00
Chris Langsenkamp
02f4eebfce updated code snip 2019-10-02 14:17:52 -04:00
Chris Langsenkamp
9d7960b842 updated code snip 2019-10-02 14:04:52 -04:00
Chris Langsenkamp
4306e08eb5 updated code snip 2019-10-02 13:48:58 -04:00
MrGadget
48bb788deb
Update ChangeLog.md 2019-10-01 13:08:23 -04:00
Paul Pacheco
07ee9ccb58 docs: move custom player docs to correct place 2019-10-01 11:27:00 -05:00
MrGadget
6cfb5c15ae
Update ChangeLog.md 2019-10-01 11:10:24 -04:00
Chris Langsenkamp
cec96677b2 Fixed link 2019-09-30 08:29:20 -04:00
Chris Langsenkamp
3579d484b2 Updated CustomPlayer doc 2019-09-29 19:51:09 -04:00
Chris Langsenkamp
f42c852127 updated CustomPlayer 2019-09-29 17:53:49 -04:00
Chris Langsenkamp
a499febe4d Changed title 2019-09-29 16:26:47 -04:00
Paul Pacheco
32c75fe14c Describe cleaner way to add customizable character (#1090)
* Describe cleaner way to add custom characters

* Update doc/articles/Guides/CustomPlayer.md

* Update doc/articles/Guides/CustomPlayer.md

* make example code clearer

* Update doc/articles/Guides/CustomPlayer.md

Co-Authored-By: MrGadget <chris@clevertech.net>

* Update doc/articles/Guides/CustomPlayer.md

Co-Authored-By: MrGadget <chris@clevertech.net>

* Update doc/articles/Guides/CustomPlayer.md

Co-Authored-By: MrGadget <chris@clevertech.net>

* Update doc/articles/Guides/CustomPlayer.md

* Update doc/articles/Guides/CustomPlayer.md

* Apply suggestions from code review
2019-09-29 14:28:18 +02:00
Chris Langsenkamp
65551a3465 Fixed title 2019-09-28 23:43:53 -04:00
Chris Langsenkamp
8538b53dea Fixed link 2019-09-28 20:57:57 -04:00
Chris Langsenkamp
268a2ccb03 Added Steamworks Networking 2019-09-28 11:07:19 -04:00
Chris Langsenkamp
44991c231c Added Master Audio Multiplayer 2019-09-28 10:15:41 -04:00
Paul Pacheco
9096eafd2f Document profiler 2019-09-28 08:09:32 -05:00
Chris Langsenkamp
a5e2cf063b Added Profiler and cleaned up 2019-09-27 12:22:24 -04:00
Chris Langsenkamp
6dcea5ffd5 Updated Changelog 2019-09-25 21:53:38 -04:00
Chris Langsenkamp
e71dd77f80 fixed code sample 2019-09-25 20:12:59 -04:00
Paul Pacheco
db2e1488c1 fix #1096 move xmldocs to docs 2019-09-24 22:42:02 -05:00
Chris Langsenkamp
747fba0dba Replaced images 2019-09-24 00:21:06 -04:00
MrGadget
f4721bba65
Update docfx.json
lower case the file name
2019-09-23 21:41:06 -04:00
Chris Langsenkamp
7c341e4e89 removed redundant bullet point 2019-09-23 00:08:41 -04:00
Chris Langsenkamp
600d11f5dd formatting 2019-09-23 00:06:36 -04:00
Chris Langsenkamp
b26ca4ad83 removed blank line 2019-09-23 00:00:49 -04:00
Chris Langsenkamp
8e8788a666 Added section about RegisterHandler 2019-09-22 23:23:11 -04:00
Paul Pacheco
135caba5be Put mirror logo in docs 2019-09-21 12:43:56 -05:00
Chris Langsenkamp
31c2ecc517 fixed PlayFab case 2019-09-21 13:18:10 -04:00
Chris Langsenkamp
28f30bd850 Made sentence clear 2019-09-21 10:23:00 -04:00
Chris Langsenkamp
6d8282e9d1 fixed API nav link 2019-09-21 01:06:20 -04:00
Chris Langsenkamp
2c41ad95e4 Added bullet for Authenticators 2019-09-21 00:38:27 -04:00
Chris Langsenkamp
535251b1e8 removed blank lines 2019-09-21 00:31:36 -04:00
Chris Langsenkamp
74fd94c327 Added Authenticators section 2019-09-21 00:28:30 -04:00
Chris Langsenkamp
9c0ce5d075 Fixed TOC files 2019-09-20 23:50:38 -04:00
Chris Langsenkamp
964c88e4be Eliminated Classes section 2019-09-20 23:34:03 -04:00
Paul Pacheco
8d6029df79 Logo now points to mirror's homepage 2019-09-20 21:22:37 -05:00
Chris Langsenkamp
c8652fa347 Eliminated articles folder and moved all up to /doc 2019-09-20 22:19:58 -04:00
Chris Langsenkamp
06ed307217 now links work with docgen 2019-09-20 21:08:56 -04:00
Chris Langsenkamp
9fcbfc5857 doc links as they should be 2019-09-20 20:55:52 -04:00
Chris Langsenkamp
d1942de744 Fixed doc links 2019-09-20 20:28:05 -04:00
Chris Langsenkamp
d635a3cec9 Culled some docs in favor of API, moved a few, navigation. 2019-09-19 07:00:50 -04:00
Chris Langsenkamp
82c647bd82 page formatting 2019-09-18 10:02:39 -04:00
Chris Langsenkamp
6a78ca0854 fixed link 2019-09-18 09:54:17 -04:00
Chris Langsenkamp
5cc505475e Updated ChangeLog and Deprecations 2019-09-18 08:52:30 -04:00
Chris Langsenkamp
8db08002d5 Doc for replacing playerController with identity 2019-09-17 21:32:34 -04:00
Chris Langsenkamp
6e4409b786 Fixed double-spaced bullets in docs 2019-09-17 20:34:26 -04:00
Chris Langsenkamp
0827e98166 Updated ChangeLog 2019-09-17 20:26:06 -04:00
Chris Langsenkamp
830850266a Merge branch 'master' of https://github.com/vis2k/Mirror 2019-09-17 11:42:58 -04:00
Chris Langsenkamp
43ca454323 Culling docs in favor of API 2019-09-17 11:42:25 -04:00
MrGadget
56bcb02c15 feat: Authentication Framework (#1057)
* Component-based Authentication

* Capitalized IsAuthenticated

* Added isAuthenticated to NetworkConnection

* Removed activeAuthenticator as unnecessary

* Removed unnecessary using

* Added more comments

* Documentation

* Added cs to code blocks in doc

* fixed typo in doc

* Doc improvements

* Fixed another typo in doc

* Removed HideInInspector

* Updated doc and image

* Fixed comment

* Added inspector header and tooltips

* Fixed typo

* Add AuthenticationData object

* Add a bullet point in the doc about AuthenticationData

* Updated screenshot image

* Added HelpURL attribute

* Added Initializers for both Server and Client

* Fixed doc grammar and phrasing

* Forgot to add the ClientInitialize in StartHost

* Updated doc with info about the initializers

* Changed initializers from bool to void.

* Eliminated the abstract model and renamed to NetworkAuthenticator and made all methods virtual

* Fixed comment

* Fixed typo

* Doc cleanup

* Doc Cleanup

* authenticator RemoveAllListeners in StopServer and StopClient

* Update Assets/Mirror/Runtime/NetworkManager.cs

Co-Authored-By: vis2k <info@noobtuts.com>

* Changes requested by Vis

* reverted conflicting change

* Revert "reverted conflicting change"

This reverts commit f65870e073.

* UnityEditor.Undo.RecordObject

* made the name camelCase

* Added internal methods and On prefix to methods

* Reverted this change so it can be done in a separate PR

* Moved authenticator calls to after runInBackground

* Add built-in timeout feature

* Changed UnityEditor.Undo.RecordObject to use gameobject

* Convert to Abstract, add Basic Authenticator, update docs.

* Removed timeout, against my better judgement.

* Removed the rest of timeout, still against my better judgement

* Fixed event listener mappings

* Renamed and consolidated methods

* updated doc and image

* made OnClientAuthenticate and OnServerAuthenticate abstract

* Updated Debug log msgs

* changed to authenticator != null

* Renamed to NetworkAuthenticator
2019-09-17 10:41:04 +02:00
Coburn
898ee1bece
Update Ignorance.md
17 Sep 2019 update
2019-09-17 15:39:31 +10:00
MrGadget
968c130b0f
Update ChangeLog.md 2019-09-16 18:18:35 -04:00
MrGadget
40dcdc8e7d
Update ChangeLog.md 2019-09-12 06:40:49 -04:00
MrGadget
dc9ed8b976
Update ChangeLog.md 2019-09-12 05:02:20 -04:00
MrGadget
58be4d44fd
Update SyncVars.md 2019-09-11 15:07:08 -04:00
MrGadget
414831d210
Update SyncVars.md 2019-09-11 14:49:34 -04:00
MrGadget
645fe58ea2
Update ChangeLog.md 2019-09-11 12:25:33 -04:00
Chris Langsenkamp
8821216b6f Renamed doc files 2019-09-11 11:16:22 -04:00
MrGadget
0e95016e95 Lobby to Room (#1065)
* Change Lobby to Room with Obsoletes

* Changed folder from Lobby to Room

* Updated docs

* reverted leftover debu.log line

* Fixed OfflineGUI

* Changed the obsolete classes to inherit from the new ones.

* Fixed SyncVar hook
2019-09-11 10:06:25 +02:00
MrGadget
d2c80d6fd3
Update index.md 2019-09-05 13:16:12 -04:00
Paul Pacheco
fc0e6f3abb
document mirror data types (#1059)
* document mirror data types

* Fix syncvar docs

* Update doc/articles/Concepts/Communications/RemoteActions.md

Co-Authored-By: MrGadget <chris@clevertech.net>

* Update doc/articles/Concepts/Communications/NetworkMessages.md

Co-Authored-By: MrGadget <chris@clevertech.net>

* Update doc/articles/Classes/SyncLists.md

Co-Authored-By: MrGadget <chris@clevertech.net>
2019-09-05 11:03:42 -05:00
Paul Pacheco
bc445e4ea1 Renamed concepts to guides 2019-09-05 09:58:27 -05:00
MrGadget
6e92cba906
Update ChangeLog.md 2019-09-04 23:44:36 -04:00
MrGadget
9332f88761
Update ChangeLog.md 2019-09-04 23:43:06 -04:00
Chris Langsenkamp
b04b740649 Updated PickupDropChild Doc 2019-08-29 10:26:14 -04:00
Chris Langsenkamp
8ff560fedf Updated PickupDropChild doc 2019-08-29 02:33:26 -04:00
Chris Langsenkamp
d9256228bf Updated PickupDropChild doc 2019-08-29 02:05:20 -04:00
Chris Langsenkamp
78f307de5c Merge master 2019-08-29 01:27:58 -04:00
Chris Langsenkamp
981ac8fa05 Replaced childObject Doc 2019-08-29 01:23:03 -04:00
MrGadget
6568bc4fa9
Update ChildObjects.md
updated code example
2019-08-28 00:46:40 -04:00
MrGadget
d578e720a4
Update SyncDictionary.md
Fixed code example
2019-08-27 09:05:52 -04:00
Chris Langsenkamp
52d5d806ff Changed to relative links 2019-08-27 08:26:41 -04:00
Chris Langsenkamp
608980424f Updated cross links 2019-08-27 07:41:49 -04:00
Chris Langsenkamp
46e1cf9b60 Added notes to ChildObject Doc 2019-08-26 22:56:41 -04:00
Chris Langsenkamp
9c082c4c60 Fixed typo in ChildObject doc 2019-08-26 00:25:31 -04:00
Chris Langsenkamp
af28ab425a Updated ChildObjects doc 2019-08-25 23:10:04 -04:00
Paul Pacheco
b83e921c06 Remove ninja websockes from api docs 2019-08-25 08:36:41 -05:00
Chris Langsenkamp
13bc9ac945 Added missing attribute 2019-08-24 20:09:11 -04:00
Chris Langsenkamp
264fd706dd Caption and typos 2019-08-24 19:34:33 -04:00
Chris Langsenkamp
9071d613ca Child Objects Doc 2019-08-24 19:30:14 -04:00
Paul Pacheco
4730b137cf Fix issue doc.csproj conflicting with other assemblies 2019-08-24 15:04:40 -05:00
Paul Pacheco
35fee94d56
docs: switch to docfx for documentation (#1026)
* Moved doc files to docfx folder

* load csproj

* doc generation

* Run docfx

* Add docfx

* Deploy docs to mirror-networking.com

* use deploy phase

* deploy whole generated site

* Fixed the semantic release command

* Is last \ required?

* show debug log

* using lftp for site deploy

* Testing lftp

* Show current folder

* try -e command option

* Show me the files

* use plain ftp

* use choco install instead of cinst

* fix ssl certificate validation

* fix username

* Upload site to xmldocs folder

* no need to archive docs

* No need for debug output

* Fix file permissions

* show me .htaccess

* Show me contents

* Wipe out folder to fix permissions

* Set file permissions

* Fix file permissions

* complete toc list

* Migrated intro page

* Remove old docs

* Update link to docs

* Add link to github

* Only update docs for stuff in master

* This is a powershell command

* Update doc/articles/Concepts/Communications/RemoteActions.md

* Update doc/articles/Concepts/VisibilityCustom.md

* Update doc/articles/Concepts/Authority.md

* Update doc/articles/Concepts/GameObjects/SpawnObjectCustom.md

* Update doc/articles/Concepts/Authority.md

* Update doc/articles/Classes/SyncVars.md

* No need to run semver twice
2019-08-24 10:20:33 -05:00