Skip to content
This repository was archived by the owner on Jul 23, 2025. It is now read-only.

Commit bf09729

Browse files
Merge branch 'master' into Boss-room-readme
2 parents 4ec26f4 + d1c669f commit bf09729

File tree

18 files changed

+165
-284
lines changed

18 files changed

+165
-284
lines changed

docs/components/networkmanager.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ When Starting a Client, the `NetworkManager` uses the IP and the Port provided i
2727
You can use different transports and have to replace the type inside the following `GetComponent< >` accordingly, but for UNET transport it looks like this:
2828

2929
```csharp
30-
NetworkManager.Singleton.GetComponent<UnetTransport>().ConnectAddress = "127.0.0.1"; //takes string
31-
NetworkManager.Singleton.GetComponent<UnetTransport>().ConnectPort = 12345; //takes integer
30+
NetworkManager.Singleton.GetComponent<UNetTransport>().ConnectAddress = "127.0.0.1"; //takes string
31+
NetworkManager.Singleton.GetComponent<UNetTransport>().ConnectPort = 12345; //takes integer
3232
```
3333

3434
## Disconnecting

docs/learn/dapper-video.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@ id: dapper-video
33
title: How To Make A Multiplayer Game In Unity 2021.1
44
---
55

6+
This page aims to collate a series of Multiplayer Unity Networking tutorial videos that teach various concepts of the new Unity Official Multiplayer solution MLAPI, all made by Dapper Dino. Learn more about Dapper Dino and his [Youtube channel](https://www.youtube.com/channel/UCjCpZyil4D8TBb5nVTMMaUw) and don't forget to click the subscribe button.
7+
8+
:::important
9+
These tutorials use Unity v2021.1. Future versions of Unity, Unity MLAPI, and Boss Room may have changes and updates to APIs and features.
10+
:::
11+
12+
## Make a Multiplayer Game
13+
614
This Unity Multiplayer Networking tutorial will teach you all about the new official Unity multiplayer solution and how to get it set up quickly in your own project!
715

816
<Iframe url="https://www.youtube.com/embed/4Mf81GdEDU8"
@@ -16,8 +24,23 @@ This Unity Multiplayer Networking tutorial will teach you all about the new offi
1624
allowfullscreen
1725
/>
1826

27+
## Lobby Password
28+
29+
This Unity Multiplayer tutorial will teach you how to implement connection approval so that clients have to send the correct password to be able to connect to the server.
30+
31+
<Iframe url="https://www.youtube.com/embed/Pe2LVZGTK20"
32+
width="854px"
33+
height="480px"
34+
id="myId"
35+
className="video-container"
36+
display="initial"
37+
position="relative"
38+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
39+
allowfullscreen
40+
/>
41+
1942
:::contribution Community Contribution
2043
Thank you to [DapperDino](https://www.youtube.com/channel/UCjCpZyil4D8TBb5nVTMMaUw) for this tutorial! This contribution is a great help to the community.
2144
:::
2245

23-
import Iframe from 'react-iframe'
46+
import Iframe from 'react-iframe'

docs/migration/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ To install MLAPI, use the Unity Package Manager passing a git URL to the MLAPI r
2222
1. Enter the Git URL to the MLAPI release package. For example, for version 0.1.0, use this link:
2323

2424
```html
25-
https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi.git?path=/com.unity.multiplayer.mlapi#0.1.0
25+
https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi.git?path=/com.unity.multiplayer.mlapi#release/0.1.0
2626
```
2727
:::info How to Copy
2828
We recommend that you use the **Copy** function in the code block above to copy the URL as other methods may result in errors. Just hover and click.

docs/migration/migratingtomlapi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ If you need help, contact us in the [Unity MLAPI Discord](https://discord.gg/buM
1111

1212
## Current limitations
1313

14-
Review the following limitations for upgrade and migrations from previous versions of MLAPI to Unity MLAPI:
14+
Review the following limitations for upgrade and migrations from previous versions of UNet to Unity MLAPI:
1515

1616
- Naming constraints may cause issues. UNet prefixed methods with `Cmd` or `Rpc`. MLAPI requires postfix. This may require either complicated multi-line regex to find and replace, or manual updates. For example, `CommandAttribute` has been renamed `ServerRpcAttribute` and `ClientRPCAttribute` has been renamed `ClientRpcAttribute`.
1717
- Errors for RPC postfix naming patterns do not show in your IDE.

docs/mlapi-api/MLAPI.Serialization.NetworkWriter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ Write bits to stream.
269269

270270
<div class="markdown level1 summary">
271271

272-
Write s certain amount of bits to the stream.
272+
Write a certain amount of bits to the stream.
273273

274274
</div>
275275

docs/template.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ To serve as an example page when styling markdown based Docusaurus sites.
1313
The doc site requires all file names in lowercase, no spaces, with dashes used as needed. This includes Markdown, images, videos, and downloadable files.
1414
:::
1515

16+
## Simple Template
17+
18+
If you need a simple template to start a new page, see the [*/template/markdown.md*](https://github.com/Unity-Technologies/com.unity.multiplayer.docs/blob/master/templates/markdown.md) file in your local cloned files. This file gives you simple Markdown to get started. For more Markdown formats, see this page's code.
19+
1620
## Markdown Frontmatter
1721

1822
All Markdown files require some information at the top of every file indicating the title, id, and other attributes as needed.

docs/tutorials/helloworldparttwo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ void OnGUI()
148148
You will notice the introduction of a new method, `SubmitNewPosition()`; which we will be using later.
149149
:::
150150

151-
13. Create a new script `HelloWorldPlayer`.
151+
8. Create a new script `HelloWorldPlayer`.
152152

153153
1. Open the `HelloWorldPlayer.cs` script.
154154
1. Edit the `HelloWorldPlayer.cs` script to match the following.
@@ -207,7 +207,7 @@ namespace HelloWorld
207207
}
208208
}
209209
```
210-
16. Select the Player Prefab.
210+
11. Select the Player Prefab.
211211
1. Add the script `HelloWorldPlayer` script as a component.
212212
![Create a Helloworldplayer script](/img/helloworldcreateplayerscript.gif)
213213

docusaurus.config.js

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,14 @@ module.exports = {
1010
organizationName: 'unity', // Usually your GitHub org/user name.
1111
projectName: 'docusaurus', // Usually your repo name.
1212
scripts: [{
13+
//OneTrust Cookie required by Unity web team
1314
src: 'https://cdn.cookielaw.org/scripttemplates/otSDKStub.js',
1415
async: true,
1516
'data-domain-script': '6e91be4c-3145-4ea2-aa64-89d716064836'
1617
}],
1718
themeConfig: {
18-
19+
//button on sidebar
20+
hideableSidebar: true,
1921
announcementBar: {
2022
id: 'prerelease', // Any value that will identify this message.
2123
content:
@@ -24,7 +26,6 @@ module.exports = {
2426
textColor: '#ffffff', // Defaults to `#000`.
2527
isCloseable: true, // Defaults to `true`.
2628
},
27-
2829
algolia: {
2930
apiKey: 'dd157a25931bf7948bfc08e79fbe2c8c',
3031
appId: '42DEOQD6E7',
@@ -60,7 +61,7 @@ module.exports = {
6061
}
6162
},
6263
navbar: {
63-
title: 'Unity Multiplayer Networking Documentation',
64+
title: 'Unity Multiplayer Networking',
6465
logo: {
6566
alt: 'Unity',
6667
src: 'img/logo.png',
@@ -100,7 +101,7 @@ module.exports = {
100101
label: 'Release Notes',
101102
position: 'left',
102103
},
103-
{to: 'blog', label: 'Blog', position: 'right'},
104+
104105
{
105106
className: 'navbar-github-link',
106107
position: 'right',
@@ -130,6 +131,7 @@ module.exports = {
130131
//label: 'Community',
131132
className: 'navbar-grid-menu',
132133
items: [
134+
{to: 'blog', label: 'Blog', position: 'right'},
133135
{
134136
label: 'Product Roadmap',
135137
href: 'https://resources.unity.com/unity-engine-roadmap/multiplayer',
@@ -266,9 +268,17 @@ module.exports = {
266268
}
267269
},
268270
},
271+
blog: {
272+
postsPerPage: 3,
273+
feedOptions: {
274+
type: 'all',
275+
copyright: `Copyright © ${new Date().getFullYear()} Facebook, Inc.`,
276+
},
277+
blogSidebarCount: 'ALL',
278+
blogSidebarTitle: 'All our posts',
279+
},
269280
theme: {
270281
customCss: require.resolve('./src/css/unity-custom.scss'),
271-
272282
},
273283
sitemap: {
274284
changefreq: 'weekly',

src/css/unity-custom.scss

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@
2626
--ifm-h5-font-size: 0.875rem;
2727
--ifm-h6-font-size: 0.85rem;
2828
--ifm-font-family-headings: Roboto, 'Segoe UI';
29+
--doc-sidebar-width: 260px !important;
30+
}
31+
32+
.menu__link {
33+
font-size: 90%;
2934
}
3035

3136
@import url('https://fonts.googleapis.com/css2?family=Roboto&display=swap');
@@ -146,6 +151,17 @@ h1, h2, h3, h4, h5, h6, .text-break {
146151
background-position: center center;
147152
}
148153

154+
.blog--primary {
155+
--ifm-hero-text-color: rgb(255, 255, 255) !important;
156+
background-image:
157+
linear-gradient(rgba(0,0,0,0.3),
158+
rgba(0,0,0,0.75)),
159+
url("../../static/img/hero-blog.jpg") !important;
160+
background-repeat: no-repeat;
161+
background-size: cover;
162+
background-position: center center;
163+
}
164+
149165
.hero {
150166
align-items: flex-start !important;
151167
}
@@ -154,6 +170,14 @@ h1, h2, h3, h4, h5, h6, .text-break {
154170
text-align: left !important;
155171
}
156172

173+
.blog-title {
174+
font-size: 2rem;
175+
}
176+
177+
.blog-subtitle {
178+
font-size: 1rem;
179+
}
180+
157181
.button.button--secondary.button--outline:not(.button--active):not(:hover) {
158182
color:rgb(255, 255, 255);
159183
}
@@ -439,10 +463,10 @@ html[data-theme='light'] .admonition-unity {
439463
color: #fff !important;
440464
}
441465
.button--secondary {
442-
--ifm-button-border-color: #80aaef;
466+
--ifm-button-border-color: #fff;
443467
}
444468
.button.button--secondary {
445-
color: #fff;
469+
color: #000;
446470
}
447471
.button--secondary:not(.button--outline) {
448472
--ifm-button-background-color: #3578e5;
@@ -520,10 +544,6 @@ html[data-theme='light'] .admonition-unity {
520544
font-size: 1rem !important;
521545
}
522546

523-
img {
524-
max-width: 350px !important;
525-
}
526-
527547
.margin-vert--xl {
528548
margin-bottom: 2rem !important;
529549
margin-top: 2rem !important;
@@ -585,10 +605,6 @@ html[data-theme='dark'] .node polygon {
585605
opacity: .8 !important;
586606
}
587607

588-
img {
589-
max-width: 700px;
590-
}
591-
592608
.imgwhite {
593609
background-color: #ffffff;
594610
}
@@ -635,7 +651,14 @@ img {
635651
text-align: right;
636652
}
637653

638-
/* CUSTOM BLOCKS */
654+
/* TABLES */
655+
656+
table {
657+
img {
658+
max-width: 150px !important;
659+
height: auto !important;
660+
}
661+
}
639662

640663
.table-rows {
641664
table {
@@ -1091,6 +1114,18 @@ html[data-theme='dark'] .DocSearch {
10911114
);
10921115
}
10931116

1117+
// TOP NAV RESPONSIVE
1118+
1119+
@media (max-width: 1011px) {
1120+
.navbar__toggle {
1121+
display: inherit
1122+
}
1123+
1124+
.navbar__item {
1125+
display: none
1126+
}
1127+
}
1128+
10941129
// VIDEO
10951130

10961131
.video-container {

src/pages/index.js

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ function Home() {
7777
<Layout
7878
title={`${siteConfig.title}`}
7979
description="This site provides Unity Multiplayer documentation, references, and sample code tutorials.">
80-
<header className={clsx('hero hero--primary hero-banner')}>
80+
<header className="hero hero--primary hero-banner">
8181
<div className="container">
8282
<h1 className="hero__title">{siteConfig.title}</h1>
8383
<p className="hero__subtitle">{siteConfig.tagline}</p>
@@ -106,6 +106,27 @@ function Home() {
106106
</section>
107107
)}
108108
</main>
109+
<div className="hero blog--primary hero-banner">
110+
<div className="container">
111+
<div className="row">
112+
113+
<div className="col col--6">
114+
<h1 className="blog-title">Get the latest news!</h1>
115+
<p className="blog-subtitle">New releases, tips and tricks, contribution news, and much more...see the blog! Every month we highlight releases, new content, and community news. </p>
116+
<div className="buttons-pages">
117+
<Link
118+
className={clsx(
119+
'button button--outline button--secondary button--lg',
120+
styles.getStarted,
121+
)}
122+
to={useBaseUrl('blog')}>
123+
See the Blog
124+
</Link>
125+
</div>
126+
</div>
127+
</div>
128+
</div>
129+
</div>
109130
</Layout>
110131
);
111132
}

0 commit comments

Comments
 (0)