diff --git a/docs/extras/zerotier.md b/docs/extras/zerotier.md new file mode 100644 index 00000000..8617652a --- /dev/null +++ b/docs/extras/zerotier.md @@ -0,0 +1,130 @@ + + +# ZeroTier for Cabinet-to-Cabinet Play + +## Installing + +!!! tip "" + + Go to the [ZeroTier download page](https://www.zerotier.com/download/). Download and run the Windows installer. + After installation, the program will open automatically in your taskbar. + +## Joining a network + +!!! tip "Connecting to a network" + + To join a network on ZeroTier, you will need its **16-digit Network ID**. + + - Start ZeroTier if it's not already running + - Right click on the ZeroTier icon in your taskbar + - Click on "Join New Network" + - Enter the Network ID + - Click on "Join" + + That's it! + +!!! info "Checking your connection" + + Open your Command Prompt, and run the command `ipconfig` + Your IP address will appear under `Ethernet adapter ZeroTier One [NETWORK ID]` next to `IPv4 Address` + + + + To check if you can successfully reach another computer on the network, run the command `ping [IPv4 Address]` replacing `[IPv4 Address]` with the IP address of the other computer, *not your own*. + +!!! tip "Configuration for segatools" + + Edit `segatools.ini` with the following content: + + ``` + [netnev] + enable=1 + addrSuffix= The last segment of your ZeroTier IP address (e.g., if your IP is 192.168.196.5, set addrSuffix = 5) + + [keychip] + subnet=192.168.196.0 + ``` + + !!! warning "Each person must have their own keychip" + + If you play on a remote network, you likely already have your own keychip. + If not, you can use these example keychips: `A61E-01D02321145` ; `A61E-01A30831145` ; `A61E-01E38091145` ; `A61E-01E46241145` + + If you're running a CHUNITHM version prior to Luminous: + + ``` + [system] + dipsw1=1 ;Set this to 1 on the host machine and set this to 0 on all others + ``` + + When starting your game, make sure to allow any Windows Firewall pop-ups (such as for `amdaemon.exe`, `mu3.exe`, `chusanApp.exe`...) + + ??? info "If you didn't see a pop-up" + + This could mean one of two things. + + Either you have already allowed it, and cab-to-cab is working successfully. That's great! No need to change anything. + Or, you denied access, and cab-to-cab isn't working. In that case follow these steps: + + - Open the Windows Control Panel + - Click on `System and Security` + - Click on `Windows Defender Firewall` + - On the left side, click on `Advanced settings` + - In the new window, click on `Inbound Rules` and look for your game's executables + - Right click on one of them, then click on `Properties` + - Select `Allow the connection` then press `OK` + - Repeat this for all game executables + +!!! tip "Configuration for spice2x" + + - Open `spicecfg.exe` + - Navigate to the `Development` tab + - Enter your ZeroTier IP in the `Preferred NetAdapter IP` field + - Enter `255.255.255.0` in the `Preferred NetAdapter Subnet` field + +## Creating a network + +!!! tip "" + + - Go to [my.zerotier.com](https://my.zerotier.com/) and create an account + - Create a network + - Click on its name in the list to configure it + +!!! info "About your Network ID" + + Your *Network ID* is displayed on your account's homepage, and in the configuration menu. + This allows you and others to [join your network](#joining-a-network). + + If your network is set to `Public` then **anyone** with it can join it. Treat it like a password. + +### Network configuration + +!!! info "Following tabs correspond to the ones found in the configuration menu, follow both "Basics" and "Advanced"" + +=== "Basics" + + !!! info "Name" + + Either keep the default random name, or rename it to your liking. + + !!! tip "Access Control" + + - **Private**: This is the default option and will require you to accept people who want to join your network + - **Public**: ^^Recommended^^, anyone with the *Network ID* can join without authorization + +=== "Advanced" + + !!! tip "Managed Routes" + + Delete the already existing entry. + Under "Add Routes", set "Destination" as `192.168.196.0/24` then press "Submit". + + !!! tip "IPv4 Auto-Assign" + + Head to the "Easy" tab, and choose `192.168.196.*` + + !!! info "" + + You should end up with this: + + \ No newline at end of file diff --git a/docs/img/extras/zerotier/config_advanced.webp b/docs/img/extras/zerotier/config_advanced.webp new file mode 100644 index 00000000..1bfab569 Binary files /dev/null and b/docs/img/extras/zerotier/config_advanced.webp differ diff --git a/docs/img/extras/zerotier/ipconfig.webp b/docs/img/extras/zerotier/ipconfig.webp new file mode 100644 index 00000000..3bf82772 Binary files /dev/null and b/docs/img/extras/zerotier/ipconfig.webp differ diff --git a/docs/img/extras/zerotier/logo.webp b/docs/img/extras/zerotier/logo.webp new file mode 100644 index 00000000..64b87369 Binary files /dev/null and b/docs/img/extras/zerotier/logo.webp differ diff --git a/mkdocs.yml b/mkdocs.yml index 3346c5e9..22370bb1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -269,6 +269,7 @@ nav: - "Asphyxia": "extras/asphyxia.md" - "Audio": "extras/audio.md" - "Cab-to-cab (SoftEther)": "extras/softether.md" + - "Cab-to-cab (ZeroTier)": "extras/zerotier.md" - "Controllers": "extras/controllers.md" - "Modding (Bemani)": "extras/datamods.md" - "Modding (Unity)": "extras/unity.md"