Commit Graph

169 Commits

Author SHA1 Message Date
rodolphito
8391236d92 Fixed typo (#595) 2019-03-13 23:01:26 -05:00
Paul Pacheco
a2d6605001
Better readability 2019-03-13 23:00:53 -05:00
Paul Pacheco
fd8389bb97
Improve readability 2019-03-13 22:57:09 -05:00
MrGadget
090be25a90
Delete Components.PNG 2019-03-13 13:20:23 -04:00
MrGadget
6c4c78f2ef
Update LiteNetLib4Mirror.md
added image
2019-03-13 13:18:46 -04:00
MrGadget
da9bb30d7d
Update WebSockets.md
added image
2019-03-13 13:17:38 -04:00
MrGadget
222b37ee1e
Update Ignorance.md
Added image
2019-03-13 13:15:51 -04:00
MrGadget
9fc28d9800
Update Fizzy.md
Fixed typo and added image.
2019-03-13 13:13:48 -04:00
MrGadget
b8ad393964
Add images for Transports 2019-03-13 13:10:16 -04:00
MrGadget
7bb4223b6e
Update ChangeLog.md 2019-03-13 11:15:25 -04:00
MrGadget
00940828fa
Update ChangeLog.md 2019-03-13 11:12:35 -04:00
MrGadget
731755d7f4
Update ChangeLog.md 2019-03-13 11:11:30 -04:00
Paul Pacheco
6eb2baaf55
Better grammar and typos 2019-03-11 18:23:42 -05:00
Paul Pacheco
b9c5aefcc1
Fix bullets in Multiplex doc 2019-03-11 18:16:24 -05:00
Paul Pacheco
f7589266e1
Document the MultiplexTransport (#585)
* Document the MultiplexTransport

* Add example of multiplex configuration
2019-03-11 18:12:13 -05:00
Raystorms
09c3a7b81a Update Fizzy.md (#583) 2019-03-11 18:53:02 +01:00
Chris Langsenkamp
1c9a21589d Update Transport Docs 2019-03-11 13:39:48 -04:00
Paul Pacheco
07e8b24bd8
Document authentication (#575) 2019-03-09 16:01:35 -06:00
Rodol Phito
a00a46cc83 Updated SpawnPlayerCustom.md 2019-03-08 22:22:04 -08:00
Rodol Phito
0b7d326007 Updated NetworkManager.md 2019-03-08 22:19:50 -08:00
Rodol Phito
71fa8c3281 Fixed Migration guide. 2019-03-08 22:12:59 -08:00
Gleb
557dee8234 Update NetworkManager.md (#568)
Mention about Awake is removed from startOnHeadless description.
2019-03-08 13:36:04 +01:00
Gleb
aae2e7d871 docs_Components_NetworkManager article rewritten (#562)
* Docs: NetworkManager article rewritten

Screenshots changed to those relevant to Mirror`s NetworkManager (made them myself)

Any information derived from UNet docs that is false in view of Mirror is deleted.

Added some mentions of Transport component at lines 23, 39 and 265

Some minor changes made in order to make article more consistent.

* Fixing typing mistakes in docs-Components-NetworkManager.md
2019-03-06 11:09:42 -06:00
Paul Pacheco
c7b8f78aae #418 Send messages without id (#422)
* Client can send/receive messages without id

* Server can send and receive messages without id

* Move message id to one common place

* Client use the new send method

* Obsolete the message ids

* Remove player uses the new api

* Refactor AddPlayer with new message api

* Provide a Pack method that gets the message id

* Convert ready message to new api

* Use new api for ObjectDestroy and ObjectHide

* Refactored ready message to new API

* Refactored SpawnSceneObjectMessage to new api

* Convert local authority message to new api

* Convert spawn started message to new api

* Convert spawn finished message to new api

* Convert upate vars message to new api

* Convert owner message to new api

* Convert pong message to new api

* Convert RPC message to new api

* Convert SyncEvent rpc to new api

* Refactor Command to new api

* Refactor Ping to new api

* Convert ErrorMessage to new api

* Convert ErrorMessage to new api

* Use int instead of short for message id to avoid collisions

* Keep only 16 bit hash for message id

* Converted Disconnect Message to new api

* Convert Connect to new message api

* Convert not ready message to new api

* Convert scene message to new api

* the Enum is no longer used for message id

* Add non obsolete version of SendToClient

* Document how to use new API

With this PR,  we no longer use Message id,  document the proper use of the api

* use C# syntax highlight

* Update NetworkMessages.md (#5)

Punctuation changes, added `cs` to code blocks.

* Write message id in short instead of packed int

* Use packer method with id

* Pass the NetworkConnection to the client message handlers
2019-03-03 14:52:35 +01:00
Paul Pacheco
ac97a3aac1 More technical rationale (#524)
* More technical rationale

Less opinion,  more technical focused analysis on the issue.

* grammar fixes

* Improved grammar

* Fix year

* Fixed typo

* wording improvement

* no need parenthesis
2019-03-02 20:57:18 +01:00
MrGadget
953cd8f762 Update ChangeLog.md (#525)
Added entry
2019-03-02 20:56:08 +01:00
MrGadget
f0949f299e Update ChangeLog.md (#505)
Added another entry
2019-03-01 01:20:26 -06:00
MrGadget
2bc401897b Update ChangeLog.md (#501)
* Update ChangeLog.md

Added entry for web sockets

* Update ChangeLog.md

* Update ChangeLog.md

* Update ChangeLog.md

Added entry for Multiplex

* Update ChangeLog.md

Rearranged the order, formatting
2019-02-28 22:17:39 +01:00
MrGadget
16909ce2e7 Update ChangeLog.md (#499)
Added entries for version 1.5
2019-02-28 20:10:20 +01:00
MrGadget
303e9fe1e0 Update ChangeLog.md (#500)
Added entries for version 1.4
2019-02-28 19:49:04 +01:00
MrGadget
3bb505c076 Docs (#497)
* Showcase and ChangeLog docs

* Fixed image file extension
2019-02-28 17:29:06 +01:00
rodolphito
d4d764fb53 Fixed erroneous documentation. (#485) 2019-02-28 11:54:11 +01:00
MrGadget
4a59f563e0 Network Lobby Updates (#438)
* Fixed 1 link to be relative
Removed Wiki link from ReadMe

* Made ClientLoadedScene virtual
Updates to scene object references
Scene and vsync handling improvements
Minor cleanup.

* removed all use of vSyncCount

* Fixed bug with ReadyToBegin being incorrectly set
2019-02-24 20:31:13 +01:00
MrGadget
cda1240444 Update Application.md (#439)
Added OnStartAuthority and OnStopAuthority entries.
2019-02-24 10:40:16 +01:00
Paul Pacheco
a47a637ded
Document transport configuration changes
Part of #333 

Transports are components now.
Configure port and address in the transport components.
2019-02-21 10:03:43 -06:00
Paul Pacheco
ea24a256f7
Highlight that TCP is optional
Highlight that TCP is optional and edits for better grammar.
2019-02-21 09:48:08 -06:00
Chris Langsenkamp
7e7683766f Network Lobby Manager & Lobby Player (#356)
* Initial Commit with Unity's Network Lobby Components

* Lobby Components WIP

* Massive simplifications and structural changes to NetworkLobbyManager and NetworkLobbyPlayer

* Replaced more default messages with Command structure resulting in further simplification and less LOC

* Completed removal of messages

* Code Formatting and GUI Layout

* Fixed bugs and finished Remove feature in UI

* Added Network Lobby Manager Doc

* Network Lobby Docs

* Network Lobby Player Doc

* Updated doc and image about Offline Scene

* changed to PNG

* Added Lobby components to navigation

* Conformed to naming convention
Removed some leftover cruft
Removed maxPlayers (redundant to maxConnections)
Trapped and killed null ref in OnServerDisconnect

* Fixed mistake in OnServerDisconnect

* Fix Active Scene check

* Alow clean switch to Offline scene

* Add Help URL attributes to components

* Added Help URL Attributes

* Fixed OnGUI logic error.

* Added Example and README

* Fixed Disconnect handler

* Updated Docs

* Added Header for Inspector

* Finished Lobby Example Minigame

* Minor cleanup

* Set targetFramerates

* Code Cleanup
Changed to extended Lobby Manager for player Indexes & colors

* Minor changes to align with Mirror's NetworkManager

* Fixed logic error

* SyncVar Hook Workaround
Random Start Positions

* Revert making CallOnClientEnterLobby public

* Added documentation to the extension

* Minor code rearrangement

* Made OnGUI virtual so it can be overridden.
Added AllPlayersReady bool for convenience to extenders
Start Game enhancement to example.

* added comments

* Corrected namespaces and usings

* Reworked DontDestroyOnLoad
LobbyPlayer: Moved code from OnStartClient to Start
Added LobbyPlayerExt to Lobby Example
Code cleanup, added regions
Fixed Start Game button bug

* Final push of Lobby example to make sure it's complete.

* Improved Lobby Example

* Code cleanup

* Added ground texture
Set player camera angle
Adjusted lighting angle

* Updated ReadMe
Cleaned up privates
Fixed example to use SetParent
Changed to 5 max connections in example

* Prefab name fixes due to Mirror master's changes
Changed camera handling and GamePlayer Prefab
Two more SetParent fixes
Demoted two warnings to information
Added more comments to example scripts

* Revisions based on Vis2K review...more to come.

* Added f's where assigning literals to floats

* Removed manual calls to SyncVar Hooks because the bug is now fixed.

* Changed to GUILayout

* wrapped in namespace

* Changed to GUILayout

* All changes per peer review

* Renamed folder to Lobby.

* Fix due to change in Mirror 1691

* Renamed Scenes
Added LobbyScene property to OfflineGUI script.
2019-02-20 16:58:50 +01:00
Lymdun
9968db8d71 Update Migration.md (#419) 2019-02-17 16:51:17 -06:00
Chris Langsenkamp
3912a5a7b1 Update Migration.md (#406)
Cross checked with the one in the project root and updated this document accordingly so the other can be removed.
2019-02-14 10:24:07 +01:00
Chris Langsenkamp
b057b24fbc Update Migration.md (#401)
Added `cs` and code block formatting
2019-02-12 10:09:18 +01:00
Chris Langsenkamp
44c9c0a672 Update Attributes.md (#398)
Removed NetworkHash128 and NetworkInstanceId from the types list.
2019-02-10 10:57:26 -06:00
Chris Langsenkamp
04e54e17ff Update SyncLists.md (#397)
Cleaned up type list and indentations / formatting
Added comment about using OnStartClient vs Start
2019-02-10 10:57:07 -06:00
Chris Langsenkamp
bdc5ef01e8 Update SpawnObjectCustom.md (#396)
Replaced `NetworkHash128` with `System.Guid`
Added `cs` to code blocks
2019-02-10 10:56:45 -06:00
Chris Langsenkamp
38dc3895e3 Update RemoteActions.md (#395)
Removed NetworkHash128 and NetworkInstanceId from the list of allowed arguments
Added `cs` to code samples.
2019-02-10 10:56:18 -06:00
Chris Langsenkamp
a2e0651d7e Update StateSync.md (#394)
Fixed title capitalization and changed example to OnStartClient instead of Start
2019-02-10 08:44:45 -06:00
Jason
8756f28eac Callback functionality was incorrectly represented (#393)
Callback functionality is achieved through event handling. I've updated the documentation here to better represent a generic SyncList as well as a custom data type.
2019-02-10 08:27:33 -06:00
Chris Langsenkamp
d1626f7842 Add a virtual method that fires on the client right before scene change so devs can implement client-side work / prep / cleanup / visuals / etc. based on what scene is about to be loaded. (#383)
Documentation updates included.
2019-02-07 13:37:54 +01:00
Jason
38033f0a11 PlayerControllers deprecated (#378)
* PlayerControllers deprecated

Please see commit 1e61aaa05a

PlayerControllers property was deprecated.

* Update NetworkConnection.md

Please review the proposed change... I'm not sure this will suffice documentation standards as I'm still new to the project.
2019-02-06 14:34:30 -06:00
Jason
81430c8cdc Dictionary 'objects' is no longer present in NetworkServer class
Please see commit d979a45870

The objects property has been deprecated and is handled by `NetworkIdentity.spawned` dictionary at this time.
2019-02-06 11:18:46 -06:00
Chris Langsenkamp
bc857796f5 Update Attributes.md (#363)
Fixes #335 along with the content added to https://github.com/vis2k/Mirror/blob/master/docs/Concepts/Communications/RemoteActions.md where TargetRpc is fully described with a proper example.

Also filled in the other descriptions.
2019-01-30 20:08:47 -06:00
Chris Langsenkamp
bc25f7c587 Update Migration.md (#364)
Added links and note about restarting Unity.  This partially addresses #333 but more work is needed.
2019-01-30 20:08:01 -06:00
Chris Langsenkamp
148aaeb6c5 Update RemoteActions.md (#362)
Fixes #339
2019-01-30 19:31:56 -06:00
Chris Langsenkamp
58aff49585 Update Deprecations (#361)
Fixes for #341
2019-01-30 19:20:34 -06:00
Chris Langsenkamp
a5b2b280d7 Update to OnServerRemovePlayer (#355) 2019-01-28 21:01:07 +01:00
uwee
ec8feea23d Remove mention of HLAPI multiple players (#352)
this is not supported by Mirror
2019-01-28 11:55:12 -06:00
Jason
ee780dc059 Update ClientsServers.md (#354)
NetworkClient.Connect() only supports a single argument - string serverIp. This documentation should be updated to reflect that difference. Please see ticket https://github.com/vis2k/Mirror/issues/341
2019-01-28 18:13:34 +01:00
uwee
f7cad9d0b3 Update Insight.md (#353) 2019-01-27 22:17:38 -06:00
uwee
d168903a3a Method parameters were changed in Mirror (#351)
Updated to match current Mirror
2019-01-27 20:11:11 -06:00
Chris Langsenkamp
70f52160a7 Added OnStartLocalPlayer Description (#336) 2019-01-22 18:13:44 +01:00
Chris Langsenkamp
27fd9b3ada Change Contributing Link 2019-01-21 21:34:54 -06:00
Chris Langsenkamp
e99a1be951 Fixed case of SyncListSTRUCT 2019-01-21 16:35:11 -06:00
Chris Langsenkamp
44902ac49e Remove navigation to Contributions
Part of removing the redundant Contributions page in docs - no point in having two of them.
2019-01-19 14:57:38 -06:00
Chris Langsenkamp
786a04880a Delete Contributions.md
Removing the redundant Contributions page in docs - no point in having two of them.
2019-01-19 14:57:23 -06:00
Chris Langsenkamp
1a44f6ed38 Added page content 2019-01-11 22:58:26 -06:00
Chris Langsenkamp
1259ef9396 Added link to Deprecations page 2019-01-11 16:28:18 -06:00
Chris Langsenkamp
f59aad7e53 Added missing links 2019-01-08 22:49:32 -06:00
Robin Rolf
ae717810c0 Corrected doc for OnClientConnect
It used to mention it being called on the server, which is false
2019-01-08 16:49:07 -06:00
Chris Langsenkamp
eaa506fb26 Fixed formatting 2019-01-07 12:45:28 -06:00
Chris Langsenkamp
847759e055 Rename SyncVarHook to SyncVarHook.md 2019-01-07 12:40:30 -06:00
Chris Langsenkamp
cded1c41f8 Added entry for Insight 2019-01-07 11:11:26 -06:00
Chris Langsenkamp
bbaaffdae2 Create page for Insight 2019-01-07 11:11:06 -06:00
Chris Langsenkamp
e0fd799100 added cs to code markdown 2019-01-07 11:10:41 -06:00
Chris Langsenkamp
d7e3f79800 Added link to SyncVarHook 2019-01-07 11:10:19 -06:00
Chris Langsenkamp
f063f40544 Added link for Insight 2019-01-07 11:10:05 -06:00
Chris Langsenkamp
a4783094bd Create SyncVar Hook page 2019-01-07 11:09:35 -06:00
Chris Langsenkamp
4d837542e4 Added Description Content 2019-01-06 21:48:05 -06:00
Chris Langsenkamp
c5a949eec1 Added descriptions to transports 2019-01-06 21:47:16 -06:00
Paul Pacheco
01f859c34d localConnections is no more 2019-01-06 09:52:17 -06:00
Paul Pacheco
07b73dea26
Fix documentation validation
site validation should work again
2019-01-01 16:56:28 -06:00
Kosio
b618fb017c Fill Server events 2018-12-31 19:31:35 -06:00
Kosio
e0902361b7 Fill Client events based on Unity's HLAPI documentation 2018-12-31 19:31:35 -06:00
Kosio
2a2194aed8 Fill Application events (with small changes from Unity's HLAPI documentation) 2018-12-31 19:31:35 -06:00
konstantin890
4609ca1a29 Documentation: Fix typo in "Custom Player Spawning"
SyncVar attribute didn't have brackets
2018-12-31 19:31:35 -06:00
Chris Langsenkamp
76b75dbb9b New Documentation (#184)
* Documentation Outline

* Spacing adjustments

* Captured old wiki content

* yml fix

* Docs work

* resize images

* Replaced images

* Removed md from links

* Renamed Misty to Fizzy

* Captured Unity docs

* links cleanup

* clear links

* Cleanup and moved NetworkBehavior to Classes.

* added slashes to yml paths

* reverted slashes

* Fixes bad link

* Update Ignorance.md

This should be enough documentation for now, yeah?

* Localized images

* Update Ignorance.md

formatting updates

* Lots of Cleanup

* fix link

* Formatting

* fix code blocks

* Lots of content and cleanup

* fixed yml

* Added blank line

* Added spaces in titles

* tightened bullets

* Fixed bullet spacing

* Fixed more bullets

* unbolded content

* Cleanup and removal of empty pages
Updated README with links to docs pages

* Restored prior version

* Contributing

* Improvements to content

* lower case fix

* fix link

* renamed Contributions

* fixed link

* home page content

* Fixed Encoding

* Moved Why TCP

* Replaced Unity with Mirror

* Telepathy Description

* changed to h2

* Moved Sample down

* Removed dead links

* Copied Contributions
Added Test
Fixed h3's

* Fixed headings

* added to Test

* Fixed image alts and links

* fixed last alt
2018-12-26 16:07:24 -06:00
Paul Pacheco
62051c74b0 Add space before disqus 2018-12-23 09:59:40 -06:00
Paul Pacheco
7ddb7df4ad Reduce space between bullet points 2018-12-23 09:55:12 -06:00
Paul Pacheco
1affe178f5 Add some separation between toc entries 2018-12-23 09:53:22 -06:00
Paul Pacheco
f85316f5c6 add some margin after code 2018-12-23 09:47:32 -06:00
Paul Pacheco
d78b5f720a Code background matches between inline and multiline 2018-12-23 09:43:29 -06:00
Paul Pacheco
b435eedfeb Reduce margin-top for h2 and h3 2018-12-23 07:52:23 -06:00
Paul Pacheco
cef22386da Fix issue scrolling to the end of sidebar 2018-12-22 22:38:10 -06:00
Paul Pacheco
8efaf5c159 Fix issue with sticking Concepts in sidebar 2018-12-22 22:31:59 -06:00
Paul Pacheco
49115b682b Fix anchor & code scrolling issue 2018-12-22 22:21:55 -06:00
Paul Pacheco
ab80b6f943 Validate documentation for broken links and images 2018-12-22 12:18:21 -06:00
Paul Pacheco
9f295e2ebf Smooth scrolling
Navigating anchors now scrolls smoothly to the anchors,  this helps usability by having visual feedback of where the previous location was
2018-12-20 22:28:41 -06:00
Paul Pacheco
708be51743 Don't include bootstrap twice 2018-12-20 21:46:34 -06:00
Paul Pacheco
49beae8d37 only apply anchor fix to h1 and h2 2018-12-20 20:41:39 -06:00
Paul Pacheco
dcaef98567 Fix issue with folder links 2018-12-20 19:39:41 -06:00
Paul Pacheco
a6f322f81d Fix anchor positioning with fixed header 2018-12-20 19:29:24 -06:00
Paul Pacheco
e7305b80da Improve color scheme 2018-12-20 18:58:28 -06:00