Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ If applicable, add screenshots to help explain your problem.
**Environment (please complete the following information):**
- OS: [e.g. Windows 10]
- Unity Version: [e.g. 2019.1]
- MLAPI Version: [e.g. v6.0.1]
- MLAPI Commit: [e.g. https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi/commit/c102935df1d7e0928283b48948fe96e5d96dd961]
- Netcode Version: [e.g. v6.0.1]
- Netcode Commit: [e.g. https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi/commit/c102935df1d7e0928283b48948fe96e5d96dd961]
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we'll come back to this link (com.unity.multiplayer.mlapi) after we rename this repository.


**Additional context**
Add any other context about the problem here. Logs, code snippets would be useful here but please also consider attaching a minimal Unity project that reproduces the issue.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feedback.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
name: Feedback
about: Provide feedback to the MLAPI team
about: Provide feedback to the Netcode for GameObjects team
title: ''
labels: stat:awaiting triage, type:feedback
assignees: ''

---

**Feedback**
Enter your feedback to the MLAPI team here. Please keep in mind that our teams focus is on multiplayer development. For other non-networking related feedback towards Unity please use the Forums.
Enter your feedback to the Netcode for GameObjects team here. Please keep in mind that our teams focus is on multiplayer development. For other non-networking related feedback towards Unity please use the Forums.

**Suggested Changes**
If you think we could do something better, please let us know here what you would like us to change. Concrete and constructive suggestions are welcome and will help us to prioritize and act on feedback.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ assignees: ''

Post your questions or problems here.

For general questions, networking advice or discussions about MLAPI, you can also reach us on our [Discord Community](https://discord.gg/FM8SE9E) or create a post in the [Unity Multiplayer Forum](https://forum.unity.com/forums/multiplayer.26/).
For general questions, networking advice or discussions about the Netcode for GameObjects, you can also reach us on our [Discord Community](https://discord.gg/FM8SE9E) or create a post in the [Unity Multiplayer Forum](https://forum.unity.com/forums/multiplayer.26/).
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIRC, we have a new sub-forum for the SDK, should we update the forum link here?

8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Here are our guidlines for contributing:

## <a name="coc"></a> Code of Conduct

Please help us keep MLAPI open and inclusive. Read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
Please help us keep Unity Netcode for GameObjects open and inclusive. Read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).

## <a name="ways"></a> Ways to Contribute

There are many ways in which you can contribute to the MLAPI.
There are many ways in which you can contribute to Netcode for GameObjects.

### <a name="issue"></a> Issues and Bugs

Expand Down Expand Up @@ -46,7 +46,7 @@ When you open a pull request, you will be asked to enter into Unity's License Ag

## <a name="submit-pr"></a> Pull Request Submission Guidelines

We use the [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for the development of MLAPI. This means development happens on the **develop branch** and Pull Requests should be submited to it.
We use the [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for the development of the Netcode for GameObjects. This means development happens on the **develop branch** and Pull Requests should be submited to it.

### Commit Message Guidelines
We have very precise rules over how our git commit messages can be formatted. This leads to **more
Expand Down Expand Up @@ -108,4 +108,4 @@ Always write a clear log message for your commits. One-line messages are fine fo

$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
> A paragraph describing what changed and its impact."
25 changes: 13 additions & 12 deletions com.unity.multiplayer.mlapi/Documentation~/Manual.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,30 @@
# About MLAPI
# About Netcode for GameObjects

Unity MLAPI is a high level networking library built for the Unity game engine to abstract networking. This allows developers to focus on the game rather than low level protocols and networking frameworks.
Unity Netcode for GameObjects is a high-level networking library built to abstract networking. This allows developers to focus on the game rather than low level protocols and networking frameworks.

## Unity MLAPI
## Guides

See this guide to install Unity MLAPI, set up your project, and get started with your first networked game.
See guides below to install Unity Netcode for GameObjects, set up your project, and get started with your first networked game:

* [MLAPI Documentation](https://docs-multiplayer.unity3d.com/docs/getting-started/about-mlapi)
* [Install MLAPI](https://docs-multiplayer.unity3d.com/docs/migration/install)
* [First Steps with Unity MLAPI](https://docs-multiplayer.unity3d.com/docs/tutorials/helloworldintro)
* [MLAPI API Reference](https://docs-multiplayer.unity3d.com/docs/mlapi-api/introduction)
* [Documentation](https://docs-multiplayer.unity3d.com/docs/getting-started/about-mlapi)
* [Installation](https://docs-multiplayer.unity3d.com/docs/migration/install)
* [First Steps](https://docs-multiplayer.unity3d.com/docs/tutorials/helloworldintro)
* [API Reference](https://docs-multiplayer.unity3d.com/docs/mlapi-api/introduction)
Comment on lines +9 to +12
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

links may or may not change, but they're here — FYI @Briancoughlin


# Technical details

## Requirements

This version of MLAPI is compatible with the following versions of the Unity Editor:
This version of Netcode for GameObjects is compatible with the following Unity versions and platforms:

* 2020.3 and later
* Windows, Mac, Linux platforms are supported by MLAPI
* Windows, Mac, Linux platforms

## Document revision history

|Date|Reason|
|---|---|
|March 10, 2021|Document created. Matches package version 0.1.0|
|June 1, 2021| Updated and added links for additional content. Matches patch version 0.1.0 and hotfixes.|
|June 3, 2021| Update document to acknowledge Unity min version change. Matches package version 0.2.0|
|June 1, 2021|Update and add links for additional content. Matches patch version 0.1.0 and hotfixes.|
|June 3, 2021|Update document to acknowledge Unity min version change. Matches package version 0.2.0|
|August 5, 2021|Update product/package name|
3 changes: 1 addition & 2 deletions com.unity.multiplayer.transport.utp/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Changelog
All notable changes to this package will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)


## [0.0.1-preview.1] - 2020-12-20
This is the first release of Unity MLAPI Package
This is the first release of Unity MLAPI Package
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# **Unity MLAPI Manual**

# **Unity Transport for Netcode for GameObjects Manual**

# Getting Started

Fill this in
todo @andrews-unity - fill this in
2 changes: 1 addition & 1 deletion com.unity.multiplayer.transport.utp/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
com.unity.transport transport for MLAPI
com.unity.transport transport for Netcode for GameObjects

WIP: This is not a functional transport just a work in progress and should not be used as any measure of current state a very early proof of concept and place holder package.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Why
Multiprocess testing can be used for different use cases like
- integration tests (MLAPI + actual transport or multi-scene testing for example)
- integration tests (Netcode + actual transport or multi-scene testing for example)
- performance testing.
- Anything requiring a more realistic environment for testing that involves having a full client and server, communicating on a real network interface using real transports in separate Unity processes.

Expand Down