docs: Update repository/project docs #636
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,84 @@ | ||
| [](https://mlapi.network/) | ||
|
|
||
| [](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi/releases/latest) | ||
| [](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi/releases) | ||
|
|
||
| [](https://forum.unity.com/forums/multiplayer.26/) | ||
| [](https://discord.gg/FM8SE9E) | ||
|
|
||
|
|
||
| [](https://github.com/MidLevel/MLAPI/blob/master/LICENSE) | ||
| [](https://docs-multiplayer.unity3d.com/) | ||
| [](https://docs-multiplayer.unity3d.com/docs/mlapi-api/introduction) | ||
|
|
||
|
|
||
| The Unity MLAPI (Mid level API) is a framework that simplifies building networked games in Unity. It offers **low level** access to core networking while at the same time providing **high level** abstractions. The MLAPI aims to remove the repetitive tasks and reduces the network code dramatically, no matter how many of the **modular** features you use. | ||
|
|
||
| ### Getting Started | ||
| To get started, check the [Multiplayer Docs Site](https://docs-multiplayer.unity3d.com/). | ||
|
|
||
| ### Community and Feedback | ||
| For general questions, networking advice or discussions about MLAPI, please join our [Discord Community](https://discord.gg/FM8SE9E) or create a post in the [Unity Multiplayer Forum](https://forum.unity.com/forums/multiplayer.26/). | ||
|
|
||
| ### Compatibility | ||
| The MLAPI supports all major Unity platforms. To use the WebGL platform a custom WebGL transport based on web sockets is needed. | ||
|
|
||
| MLAPI is compatible with Unity 2019 and newer versions. | ||
|
|
||
| ### Development | ||
| We follow the [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). The master branch contains our latest stable release version while the develop branch tracks our current work. | ||
|
|
||
| This repository is broken into multiple components, each one implemented as a Unity Package. | ||
| ``` | ||
| . | ||
| ├── com.unity.multiplayer.mlapi # The core netcode SDK unity package (source + tests) | ||
| ├── com.unity.multiplayer.transport.utp # Transport wrapper for com.unity.transport experimental package (not currently supported) | ||
| └── testproject # A Unity project with various test implementations & scenes which exercise the features in the above package(s). | ||
| ``` | ||
|
|
||
| ### Contributing | ||
| The MLAPI is an open-source project and we encourage and welcome | ||
| contributions. If you wish to contribute, be sure to review our | ||
| [contribution guidelines](CONTRIBUTING.md) | ||
|
|
||
| ### Issues and missing features | ||
| If you have an issue, bug or feature request, please follow the information in our [contribution guidelines](CONTRIBUTING.md) to submit an issue. | ||
|
|
||
| ### Example | ||
| Here is a sample MonoBehaviour showing a chat script where everyone can write and read from. This shows the basis of the MLAPI and the abstractions it adds. | ||
|
|
||
| ```csharp | ||
| public class Chat : NetworkBehaviour | ||
| { | ||
| private NetworkList<string> ChatMessages = new NetworkList<string>(new MLAPI.NetworkVariable.NetworkVariableSettings() | ||
| { | ||
| ReadPermission = MLAPI.NetworkVariable.NetworkVariablePermission.Everyone, | ||
| WritePermission = MLAPI.NetworkVariable.NetworkVariablePermission.Everyone, | ||
| SendTickrate = 5 | ||
| }, new List<string>()); | ||
|
|
||
| private string textField = ""; | ||
|
|
||
| private void OnGUI() | ||
| { | ||
| if (IsClient) | ||
| { | ||
| textField = GUILayout.TextField(textField, GUILayout.Width(200)); | ||
|
|
||
| if (GUILayout.Button("Send") && !string.IsNullOrWhiteSpace(textField)) | ||
| { | ||
| ChatMessages.Add(textField); | ||
| textField = ""; | ||
| } | ||
|
|
||
| for (int i = ChatMessages.Count - 1; i >= 0; i--) | ||
| { | ||
| GUILayout.Label(ChatMessages[i]); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### License | ||
| [MIT License](LICENSE) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the idea of having the readme mirrored in the package root? I don't see other packages do that. Unity Editor also does not support markdown so this will look pretty ugly when people view this file in our package.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Unity Standards group told us that we should have a readme in the root and one per package, though there's nothing solid on what goes in one readme vs the other. If you want to take a stab at a package-specific readme please do so, but I think having this information in the repo root is preferred as our primary focus is and will always be the sdk package.