After you have made the account, navigate to the setup page
$ ngrok config add-authtoken THE-AUTHTOKEN-GIVEN
Change 'the-authtoken-given' to the one given on the website.
Step 2c. Configuring everything
In the menu, enter '2' as the choice, and configure everything to your liking.
Read the prompt, and type 'Y/N' or whatever it asks for. Your Ngrok-Auth token is necessary if you want to use the NGROK-Autostart feature. If you do not want to enter the token, you can go to the Ngrok setup page, and manually set it up.
Go to Discord, your server, the channel, and click on settings. Then go to integrations, and expand it.
Click on the desired integration, and copy the URL as shown. Then enter it in the prompt.
Step 3. Running the USSR
If you've done everything correctly, start the USSR.
It should send the URLs in Discord, and you should be able to visit the website on localhost:443
Step 4: Installing Packetriot to expose the Flask app to your friends
$ cd ~/path/to/ussr/directory
$ git clone https://aur.archlinux.org/pktriot.git
$ cd pktriot
$ makepkg -si
$ pktriot http 443
It will ask you for an Email & Password. Head over to Packetriot and make an account, once done, proceed.
Example:
Email: mickey@koolkids.klan
Password: asirrationalaspi
This will log you in; it may say 'permission denied.' To fix this, run:
$ sudo pktriot http 443
for ussr-ssl.py
$ sudo pktriot http 80
for ussr.py
Windows Installation
Head over to Packetriot and make an account, once done, proceed.
Now that you have an account, go to the downloads page, and scroll down until you find the download for your Windows system's architecture. (32-bit or 64-bit.)
After you have downloaded the file, create a new folder in the 2.0 directory, and extract the pktriot.exe there. Open command prompt in an elevated window, and type:
$ pktriot.exe http 443
for ussr-ssl.py
It will ask you for a login, so type in the credentials of the account you created earlier — and that's it!
Manual guide
This is deprecated, please see newer guide above.
For Arch
NOTE: This tutorial is for a Fabric server. If you want to use something like PaperMC,
Glowstone, or Airplane, figure it out -- it isn't rocket science.
Step 1: Acquire the file
$ mkdir server
$ cd ~/server
$ wget https://meta.fabricmc.net/v2/versions/loader/1.19.4/0.15.3/1.0.0/server/jar
$ mv fabric-server-mc.1.19.4-loader.0.15.3-launcher.1.0.0.jar fabric.jar
Create a text document (.txt) named eula.txt and in the contents of the document, type eula=true.
Open an elevated command prompt window in the server folder
$ java -jar -Xms256M -Xmx5G fabric.jar
$ stop
Step 3: RCON settings
After this, open `server.properties` with whatever text-editor, and change:
RCON port to 25575
RCON password to root_admin
RCON address localhost
Configuring paths (Arch)
FYI: The following tutorial should be (almost) the same for any other text editor; however, my preferred is nano, so I will be using that. You can use anything like OSS, Neovim, Vim, or even Kate... (Kate?)
Step 1: Editing `ussr(-ssl).py`
Edit ussr-ssl.py using Nano or any text editor.
Let's say we have a user called Katie, and Katie put the USSR folder in ~/Desktop/USSR/Archlinux/
We would edit the file as follows if the above is met:
Line 16, Col 58
Line 39, Col 48
And that's it for the Archlinux set-up.
Configuring paths (Windows)
FYI: Use VSCode if you want to make your life a (little) easier.
Step 1: Editing `ussr(-ssl).py` on Windows
Edit ussr-ssl.py using any text editor.
Let's say we have a user called Katie, and Katie put the USSR folder in their Desktop folder. So:
C:\Users\Katie\Desktop\USSR\Windows
We would edit the file as follows if the above is met:
Line 16, Col 58
Line 39, Col 48
Step 2: Editing Ngrok path on Windows
Let's say Katie placed the downloaded Ngrok executable in her D:\ drive.
D:\Ngrok\bin\ngrok.exe
Installing Packetriot for Archlinux
Step 1: Installing Packetriot to expose the Flask app to your friends
$ cd ~/path/to/ussr/directory
$ git clone https://aur.archlinux.org/pktriot.git
$ cd pktriot
$ makepkg -si
$ pktriot http 443
$ pktriot http 80
It will ask you for an Email & Password. Head over to Packetriot and make an account, once done, proceed.
Example:
Email: mickey@koolkids.klan
Password: asirrationalaspi
This will log you in; it may say 'permission denied.' To fix this, run:
$ sudo pktriot http 443
for ussr-ssl.py
$ sudo pktriot http 80
for ussr.py
Windows Installation
Head over to Packetriot and make an account, once done, proceed.
Now that you have an account, go to the downloads page, and scroll down until you find the download for your Windows system's architecture. (32-bit or 64-bit.)
After you have downloaded the file, create a new folder in the 2.0 directory, and extract the pktriot.exe there. Open command prompt in an elevated window, and type:
$ pktriot.exe http 443
for ussr-ssl.py
$ pktriot.exe http 80
for ussr.py
It will ask you for a login, so type in the credentials of the account you created earlier — and that's it!
Archlinux Installation
This guide assumes you have basic Archlinux & overall Linux experience. Please fix the issue yourself if you encounter any.
Step 1: Let's install Python & dependencies
$ sudo pacman -S python
$ cd ussr-xyz
(ussr-***xyz*** is the version, e.g., you are using version 2.2, that would be: ussr-2.2)
$ cd archlinux
$ chmod +x install.sh
$ ./install.sh
Step 2: Running the USSR
$ cd server-arch
$ sudo python ussr(-ssl).py
(ussr-ssl.py is optional, use the SSL version if you want HTTPS instead of HTTP. It doesn't matter if you will use Pktriot, though.)
Installing the USSR on MacOS, Debian, or any other Linux distribution, such as Gentoo is super easy, simple, and straight forward. You just need to manually install all the dependencies yourself, then run launcher.py and skip through dependency/prerequisite setup. That's all!
