Mirror/doc/Guides/toc.yml

35 lines
780 B
YAML
Raw Normal View History

2019-09-21 03:50:38 +00:00
- name: Overview
href: index.md
- name: Authority
href: Authority.md
- name: About IDs
href: IDs.md
- name: Authentication
href: Authentication.md
feat: LAN Network discovery (#1453) * Fix typo * Updated Changelog * first commit * Add example for discovery * NetworkDiscovery component should be added * fixed UI * Fix some warnings * refactor: network discovery reimplemented * Remove unused GUIstyle * Fix namespaces * Just send to the broadcast address * Fix indentation * Log errors in ClientListen * Code formatting cleanup, HelpURL's fixed, comments revised. (#38) * Transport can now provide server uri * work with any transport by passing uri * Move discovery initialization to start * feat: Discovery can now be easily customized per game * Use generics to simplify api * Renamed ServerInfo -> ServerResponse * Rename method * Moved up one folder * Move ServerId to NetworkDiscovery * tests now reference Mirror.Discovery * Cleaned up blank space * Disable GUID apparently fixes it * Use UnityEvents for ease of use * Remove noisy log * remove blank spaces * Process request receives the client endpoint * use consistent name for parameters * Remove white space * Keep it minimalistic, we don't need age or totalPlayers * Comment non obvious property * Don't break transports * Documentation and image * Code formatting * removed privates * Added Range attribute * Rename ActiveDiscoverySecondInterval * Revised NetworkDiscovery doc * Swapped field order (Cosmetics) * Added ScriptTemplate * Update ProjectSettings/ProjectVersion.txt * Updated ScriptTemplate * Updated xml comment and ScriptTemplate * Updated ScriptTemplate * Improve xmldocs * Improve xmldocs * Remove leftover comment * Renamed event * Moved discovery inside components * Keep parameter names consistent * Provide a guide for network discovery * XML Comments and ScriptTemplate * Moved Credits * fixed template * Removed comment * removed comment * xml comments and template * fixed method name * fixed method and template * removed semicolon * fixed template * fixed method and template * fixed template * fixed template * Fix copypasta error * Show error if no url is available Network Discovery now shows an error if the transport does not support providing Url * Grammar fix * Extended Template * fixed template * Added guide link to template * New image * Update NetworkDiscovery.md * Updated Guid Doc and Template * fixed bullets * Remove unnecessary using * Make it like Mirror's * Update ScriptTemplates Image & Zip * Removed from Deprecations * Updated ChangeLog * Updated ChangeLog * Update NetworkDiscovery.md Remove last line...this was copied to the paragraph above the code block Co-authored-by: MrGadget <chris@clevertech.net>
2020-01-29 08:56:29 +00:00
- name: Network Discovery
href: NetworkDiscovery.md
2019-09-29 03:43:53 +00:00
- name: Network Profiler
2019-09-29 00:57:57 +00:00
href: Profiler.md
2019-09-21 03:34:03 +00:00
- name: Attributes
href: Attributes.md
2020-02-18 04:10:47 +00:00
- name: Network Behaviour
2020-02-18 16:34:07 +00:00
href: NetworkBehaviour.md
- name: Clock Synchronization
href: ClockSync.md
- name: Data Types
href: DataTypes.md
- name: Visibility
href: Visibility.md
docs: Explain how to set a server in AWS (#1365) * Create DevelopmentServer.md This guide focuses on helping people try out their projects on a dedicated server so a more realistic test can be performed to see if everything works correctly. This focuses on the free/trial aspect from the chosen providers and tries to make it very clear to readers that "free" is relative and Mirror can not be held responsible if they go above the providers limits. It is mainly a guide on setting up the dedicated server through different providers to test your Mirror project. Question: Should I put it all under each other or should each provider/possibility be a different page like synchronization/GameObjects? For example: Overview AWS Azure Google * Make dedicated servers a submenu * Add files via upload * Move AWS inside it's own folder * Update index.md Changed the imgur links to the github images in the AWS folder so offline access is possible * Update index.md As suggestion from SoftwareGuy from suggestion: https://github.com/vis2k/Mirror/pull/1365#discussion_r361819820 I have made this in a bullet point so it's more clearly visible * Update index.md * Update index.md * Update index.md Added the changes as SoftwareGuy mentioned * Update index.md Another update to the formatting. Changed some parts to titles so it's easier to navigate through the right hand side on github pages. Some more formatting done * Update index.md Changed the titles from the 7 steps to include the step number for easier following * Update index.md Forgot this one: https://github.com/vis2k/Mirror/pull/1365#discussion_r361819874 Co-authored-by: Paul Pacheco <paulpach@gmail.com>
2019-12-29 17:44:26 +00:00
- name: Development Servers
2020-01-06 09:23:57 +00:00
href: DevServer/toc.yml
topicHref: DevServer/
2019-10-20 03:45:52 +00:00
- name: Synchronization
2019-09-21 03:34:03 +00:00
href: Sync/toc.yml
topicHref: Sync/
- name: Communications
href: Communications/toc.yml
2019-09-21 03:34:03 +00:00
topicHref: Communications/
- name: GameObjects
href: GameObjects/toc.yml
2019-09-21 03:34:03 +00:00
topicHref: GameObjects/