Merge pull request #2 from cosmin-bararu/docs/repository-docs
docs: repository docs
This commit is contained in:
Коммит
0a02881cff
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: stat:awaiting triage, type:bug
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
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]
|
||||
- Shared Samples Repository Version/Commit
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
|
@ -0,0 +1,8 @@
|
|||
blank_issues_enabled: True
|
||||
contact_links:
|
||||
- name: Discord
|
||||
url: https://discord.gg/buMxnnPvTb
|
||||
about: Join us on Discord for questions, support and discussions.
|
||||
- name: Unity Multiplayer Forum
|
||||
url: https://forum.unity.com/forums/multiplayer.26/
|
||||
about: Create a thread in the Unity Multiplayer Forum.
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: stat:awaiting triage, type:feature
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
name: Feedback
|
||||
about: Provide feedback to the MLAPI 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.
|
||||
|
||||
**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.
|
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
name: Other Issues
|
||||
about: Use this template for any other non-support related issues
|
||||
title: ''
|
||||
labels: stat:awaiting triage
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
This template is for issues not covered by the other issue categories.
|
|
@ -0,0 +1,12 @@
|
|||
---
|
||||
name: Support
|
||||
about: Have a question or need help with anything?
|
||||
title: ''
|
||||
labels: stat:awaiting triage, type:support
|
||||
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/).
|
|
@ -0,0 +1 @@
|
|||
The MLAPI Shared Samples Repository follows the same code of conduct as the MLAPI repository. Please read the [MLAPI code of conduct](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi/blob/master/CODE_OF_CONDUCT.md), thank you!
|
|
@ -0,0 +1,38 @@
|
|||
# Contributing
|
||||
|
||||
Thank you for your interest in contributing to MLAPI Shared Samples Repository!
|
||||
|
||||
Here are our guidelines for contributing:
|
||||
|
||||
* [Code of Conduct](#coc)
|
||||
* [Ways to Contribute](#ways)
|
||||
* [Issues and Bugs](#issue)
|
||||
* [Feature Requests](#feature)
|
||||
* [Improving Documentation](#docs)
|
||||
* [Unity Contribution Agreement](#cla)
|
||||
* [Pull Request Submission Guidelines](#submit-pr)
|
||||
|
||||
## <a name="coc"></a> Code of Conduct
|
||||
|
||||
Please help us keep BossRoom open and inclusive. Read and follow our [Code of Conduct](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi/blob/master/CODE_OF_CONDUCT.md).
|
||||
|
||||
## <a name="ways"></a> Ways to Contribute
|
||||
|
||||
There are many ways in which you can contribute to the BossRoom.
|
||||
|
||||
### <a name="issue"></a> Issues and Bugs
|
||||
|
||||
If you find a bug in the source code, you can help us by submitting an issue to our
|
||||
GitHub Repository. Even better, you can submit a Pull Request with a fix.
|
||||
|
||||
### <a name="feature"></a> Feature Requests
|
||||
|
||||
Please note that the goal of this repository is to provide educational content to learn MLAPI.
|
||||
|
||||
If you would like to see a certain feature in the samples or implement one yourself, create a request by [submitting an issue](TODO Link) to our GitHub Repository.
|
||||
|
||||
If you would like to implement a new feature then please also get in contact with us in the #dev-samples channel of our [Discord](https://discord.gg/buMxnnPvTb).
|
||||
|
||||
## <a name="cla"></a> Contributor License Agreements
|
||||
|
||||
When you open a pull request, you will be asked to enter into Unity's License Agreement which is based on The Apache Software Foundation's contribution agreement. We allow both individual contributions and contributions made on behalf of companies. We use an open source tool called CLA assistant. If you have any questions on our CLA, please submit an issue
|
|
@ -0,0 +1,5 @@
|
|||
MLAPI Shared Samples copyright © 2021 Unity Technologies ApS
|
||||
|
||||
Licensed under the Unity Companion License for Unity-dependent projects--see [Unity Companion License](https://unity3d.com/legal/licenses/Unity_Companion_License).
|
||||
|
||||
Unless expressly provided otherwise, the Software under this license is made available strictly on an “AS IS” BASIS WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. Please review the license for details on these and other terms and conditions.
|
18
README.md
18
README.md
|
@ -1,12 +1,24 @@
|
|||
# MLAPI Shared Samples
|
||||
|
||||
The aim of this repository is to represent a collection of mini sample projects/games that showcase different
|
||||
|Unity Version|MLAPI Version|
|
||||
|:-------:|:-------:|
|
||||
|2020.3|0.1.0|
|
||||
|
||||
This repository contains a collection of mini sample projects/games that showcase different
|
||||
sub-features of [MLAPI](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi)
|
||||
as well as being used for [Documentation](https://docs-multiplayer-sandbox.unity3d.com/docs/getting-started/about-mlapi) purposes.
|
||||
|
||||
## Who is this for?
|
||||
|
||||
This repo is mainly targeting Unity developers that want to get started with development of a multiplayer
|
||||
The samples in this repository exist to help you getting started with development of a multiplayer
|
||||
project using [MLAPI](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi)
|
||||
that just got past the "Hello World" stage and are interesting in how they can use some specific sub-features of [MLAPI](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi) in a more self-contained scenario.
|
||||
if you just got past the "Hello World" stage and are interested in how you can use some specific sub-features of [MLAPI](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi) in a more self-contained scenario.
|
||||
|
||||
## Community and Feedback
|
||||
For help, questions, networking advice or discussions about MLAPI and its extensions, 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/).
|
||||
|
||||
## Maintenance
|
||||
The Shared Samples Repository will be kept up to date with the latest released MLAPI version and LTS version of Unity. We indicate the currently used versions of Unity and MLAPI at the top of the readme.
|
||||
|
||||
## Contributing
|
||||
Check out or [contribution guidelines](CONTRIBUTING.md)
|
Загрузка…
Ссылка в новой задаче