Added networking section.

Koopa 2017-11-04 18:05:39 -04:00
parent a403c58ec4
commit 48514df6ac

43
FAQ.md

@ -166,6 +166,49 @@ Example of games that suffer from this:
*** ***
## Networking Support
#### What is this?
Citra's networking support emulates the 3DS' local wifi. On a real 3DS, this allows you to play games with people next to you. With Citra's implementation of this feature, you can play with other people on Citra anywhere. **This is not an implementation of connecting to Nintendo's servers over wifi, nor is it an implementation of download play.**
#### Why don't I have this feature?
Currently, networking support is only in the [Canary version](https://github.com/citra-emu/citra-canary/releases/latest) of Citra.
#### What's the difference between public and unlisted rooms?
When you make a public room, Citra connects to the [Citra Web Service](https://citra-emu.org/wiki/citra-web-service/), authenticates yourself using your token and username, and sends the room details. Then, the Citra Web Service will add your room to the public room listing, so when people go in the Public Game Lobby, they will see the room. Something important to note about a public room is that **the Citra Web Service only hosts room listings, and not the room itself. The room will still be hosted on your computer.**
When you make an unlisted room, Citra opens a room for any incoming connections, without connecting to the Citra Web Services. For other people to join the room, they will need to enter your IP manually, since they're not going through the Public Game Browser listing.
#### How do I join a public room?
To join a public room, follow these steps:
1. Go to `Multiplayer` in the menu bar, and click `Browse Public Game Lobby`.
2. Set your nickname in the top left.
3. Double click on a room in the Public Room Browser dialog to join it.
4. Double click on a game in the Citra main window to start it.
#### How do I join a unlisted room?
To join a unlisted room, follow these steps:
1. Go to `Multiplayer` in the menu bar, and click `Direct Connect to Room`.
2. Enter the IP and port of the host you're connecting to, your nickname, and password of the room if applicable.
3. Click connect to join the room.
#### How do I make a public room?
To make a public room, follow these steps:
1. **If you and the people you are playing with are on different wifi networks, setup port forwarding in your router settings.**
2. Go to `Multiplayer` in the menu bar, and click `Create Room`.
3. Enter the name of your room to be shown in the public listing and chat window, your preferred nickname, the game that will be played, an optional password if you need it, and the max number of players that can join the room. Unless you know you need it, you shouldn't have to touch the port number.
4. Click `Host Room` to create the room.
#### How do I make an unlisted room?
To make an unlisted room, follow these steps:
1. **If you and the people you are playing with are on different wifi networks, setup port forwarding in your router settings.**
2. Go to `Multiplayer` in the menu bar, and click `Create Room`.
3. Enter the name of your room to be shown in the chat window, your preferred nickname, the game that will be played, an optional password if you need it, and the max number of players that can join the room. Unless you know you need it, you shouldn't have to touch the port number.
4. At the bottom, set the room type combo box to `Unlisted`.
5. Click `Host Room` to create the room.
***
## Development and contributions ## Development and contributions
#### How can I develop or contribute to the project? #### How can I develop or contribute to the project?