yuzu/yuzu-emu.github.io
1
0
Fork 0
mirror of https://github.com/yuzu-emu/yuzu-emu.github.io.git synced 2025-06-08 13:27:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Address review comments

Browse source
This commit is contained in:
FearlessTobi 2022-09-03 06:37:08 +02:00
parent ffca03d7db
commit 2a059d6e1b
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
site/content/help/feature/multiplayer/index.md
View file

@ -8,7 +8,7 @@ description = "yuzu's multiplayer feature has the ability to emulate local wirel
Unlike single console netplay used in most emulators, users won’t have to worry about desyncs, synchronizing saves, or any other issues typical of netplay. Each user is using their instance of *yuzu* as a unique emulated Switch that is communicating with everyone else through a *multiplayer room*, a server that can be hosted by anyone for connected clients to exchange data with each other.
You can learn more about *yuzu*'s multiplayer features in [this article](https://yuzu-emu.org/entry/announcing-networking-support/).
You can learn more about *yuzu*'s multiplayer features in [this article](https://yuzu-emu.org/entry/ldn-is-here/).
## Hosting Rooms
If you just want to play with your friends, **you do not need to create your own room**. You can just pick a room from our Public Room Browser, where plenty of public rooms hosted by us and the community are already available for use.
@ -19,7 +19,7 @@ However, if you really want to host your own dedicated room, there are a few poi
* As a room is actually a server, the computer hosting it has to be running 24x7. Therefore, it is usually not feasible to use your home or work PC to host a room.
* To ensure the best experience while playing, rooms should have a good Internet connection as well as a high bandwidth. *This is especially important if you are hosting a public room - no one would want random disconnections while playing!*
* yuzu rooms can be quite costy in terms of data transfer. It has been reported that some popular public rooms transfer over 1TB of data in a single month.
* yuzu rooms can be quite costly in terms of data transfer. Please be aware that hosting a popular public room can cause a lot of traffic for your server.
Therefore, the best option to host a room is usually to use a VPS provider, such as [Linode](https://linode.com) or [DigitalOcean](https://www.digitalocean.com), to name a few.
@ -53,13 +53,13 @@ Make sure the ports specified in `--publish` matches the port specified in `--po
You can also save this command (with arguments filled in) as a script for easier usage.
## Hosting on Windows
If you are on Windows, it is also possible to host rooms using a standalone executable. As you may already know, every *yuzu* release comes with three executables - `yuzu` (The command line emulator frontend), `yuzu-qt` (The GUI emulator frontend) and `yuzu-room`, the dedicated room server which we'll use.
If you are on Windows, it is also possible to host rooms using a standalone executable. As you may already know, every *yuzu* release comes with three executables - `yuzu-cmd` (The command line emulator frontend), `yuzu` (The GUI emulator frontend) and `yuzu-room`, the dedicated room server which we'll use.
Steps:
1. If you do not have a *yuzu* installation yet, install it with the installer from our [official website](https://yuzu-emu.org).
1. Navigate to the folder you installed *yuzu* to, and go into `nightly-mingw` or `canary-mingw`.
* If you cannot recall the installation folder, right clicking on a shortcut and clicking `Open File Location` will directly bring you into the `nightly-mingw` or `canary-mingw` folder.
1. Navigate to the folder you installed *yuzu* to, and go into `yuzu-windows-msvc` or `yuzu-windows-msvc-early-access`.
* If you cannot recall the installation folder, right clicking on a shortcut and clicking `Open File Location` will directly bring you into the `yuzu-windows-msvc` or `yuzu-windows-msvc-early-access` folder.
* Make sure the folder you are in contains the `yuzu-room` executable.
1. Create a new text file and copy the following script inside, **fill in the arguments** (they will be explained later) and then use `File > Save As...` to save it to `host.bat`. You can delete the original text file after that.
1. You can now double click on the batch script named `host` to start hosting.
@ -72,7 +72,7 @@ yuzu-room ^
--preferred-game-id "<INSERT TITLE ID HERE>" ^
--port 5000 ^
--max_members 4 ^
--token "<INSERT yuzu ACCOUNT TOKEN HERE>" ^
--token "<INSERT YUZU ACCOUNT TOKEN HERE>" ^
--enable-yuzu-mods ^
--web-api-url https://api.yuzu-emu.org/ ^
--ban-list-file "<INSERT BAN LIST FILE PATH HERE>"
@ -96,7 +96,7 @@ By default, rooms will be hosted Public. If you'd like to host a private one ins
|`--port`|Yes|Port number to host your room on (0-65535). You should use a port that is not already used by other applications (typically a high enough port will work). Though unrecommended due to bandwidth reasons, it is possible to host multiple rooms on a single server provided the ports are distinct. **Remember to configure `Port Forwarding` for the ports!**
|`--max-members`|Yes|Maximum number of members for your room (2-16). *Note that rooms that are too large may result in slowdowns or even disconnections in certain games.*
|`--password`|No|An optional password to limit access to your room.
|`--token`|Public Rooms|Your *yuzu* Community user token. Do not know your token yet? Get it [here](https://yuzu-emu.org/wiki/yuzu-web-service/). **Please note, the token format has changed as of 11/1/2019 and there is now no need for a `--username` field.**
|`--token`|Public Rooms|Your *yuzu* Community user token. Do not know your token yet? Get it [here](https://yuzu-emu.org/wiki/yuzu-web-service/).
|`--web-api-url`|Public Rooms|URL to the *yuzu* Web API. You should not change this.
|`--ban-list-file`|No|This is a file which yuzu will store ban records in. Banning would still work even if you do not specify this, but the bans will be lost once you shut down the room.
|`--log-file`|No|File path to store the logs.
@ -104,7 +104,7 @@ By default, rooms will be hosted Public. If you'd like to host a private one ins
Additionally, a flag `--enable-yuzu-mods` is available. By enabling this flag, you will grant *yuzu* Community Moderators the power to moderate on your room. Do not worry, this is entirely optional and your room will still be listed even if you do not enable this.
## Authentication and Moderation
As you may already know, *yuzu* multiplayer rooms can authenticate users and grant certain users moderation privileges. Authenticated users get their *yuzu* Community username and avatar shown in the member list, and others can right click on them to view their *yuzu* Community profile.
*yuzu* multiplayer rooms can authenticate users and grant certain users moderation privileges. Authenticated users get their *yuzu* Community username and avatar shown in the member list, and others can right click on them to view their *yuzu* Community profile.
Note that this feature requires interacting with the *yuzu* Web API, and therefore is only enabled for *public rooms in the Public Room Browser*. Directly connecting to the rooms (with `Direct Connect`) will leave you unauthenticated.