Skip to content
This repository has been archived by the owner on Sep 30, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mickoissicko authored Jan 25, 2024
1 parent 4890f82 commit 6c90885
Showing 1 changed file with 108 additions and 31 deletions.
139 changes: 108 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,123 @@
# The USSR
> What is it?
I started this program as a barebones, small, and lightweight tool to allow my friends to start/stop the SMP if I am unable to do it.

It acts as a server panel. Pretty cool if you ask me.

> Why is it better than server hosting?
Well first of all... IT'S FREE. 0 DOLLAHS. Completely free. Forever. Yes, I copied Aternos -- why not use that?

Aternos sucks, and stops server after 3-5 minutes of inactivity, and it has limited RAM. With this, you can host your own server, have 100% control over it, unlimitied RAM & CPU, as well as amazing ping because you can utilise the many locations Ngrok offers ... for FREE!

My friend gets ~200ms average on Aternos, but on Ngrok's Singapore location, around 90ms. (He lives near Singapore!)

> How do I use it?
Check the official [Wiki](https://mick.gdn/dir.html)

# Info
You need to kill all Ngrok processes before re-running / restarting the USSR. After the USSR process is terminated, it itself does not stop the Ngrok processes which is a problem. Ngroksenpai freaks out and doesn't correctly send all the IPs.

To kill processes on Arch:

`sudo kill ngrok`

To kill processes on Windows:

`taskkill /f /im ngrok.exe`

# Tree

.

├── archlinux
│ ├── install.sh
│ ├── instructions.txt
│ ├── server-arch
│ │ ├── config
│ │ │ └── conf.txt
│ │ ├── conf.txt
│ │ ├── script
│ │ │ ├── ngroksenpai.py
│ │ │ ├── starter.sh
│ │ │ └── stop.py
│ │ ├── templates
│ │ │ ├── index.html
│ │ │ └── nuke.png
│ │ ├── ussr.py
│ │ └── ussr-ssl.py
│ └── setup
│ ├── arch.py
│ ├── start.sh
│ └── token.txt

│   ├── install.sh

│   ├── instructions.txt

│   ├── server-arch

│   │   ├── config

│   │   │   └── conf.txt

│   │   ├── conf.txt

│   │   ├── script

│   │   │   ├── ngroksenpai.py

│   │   │   ├── starter.sh

│   │   │   └── stop.py

│   │   ├── templates

│   │   │   ├── index.html

│   │   │   └── nuke.png

│   │   ├── ussr.py

│   │   └── ussr-ssl.py

│   └── setup

│   ├── arch.py

│   ├── start.sh

│   └── token.txt

├── instructions.txt

├── launcher.py

├── README.md

├── token.txt

└── windows

├── install.bat

├── instructions.txt

├── server-windows
│ ├── config
│ │ └── conf.txt
│ ├── conf.txt
│ ├── script
│ │ ├── ngroksenpai.py
│ │ ├── starter.bat
│ │ └── stop.py
│ ├── templates
│ │ ├── index.html
│ │ └── nuke.png
│ ├── ussr.py
│ └── ussr-ssl.py

│   ├── config

│   │   └── conf.txt

│   ├── conf.txt

│   ├── script

│   │   ├── ngroksenpai.py

│   │   ├── starter.bat

│   │   └── stop.py

│   ├── templates

│   │   ├── index.html

│   │   └── nuke.png

│   ├── ussr.py

│   └── ussr-ssl.py

└── setup

├── prerequisites.bat

├── start.bat

├── token.txt
└── win.py

0 comments on commit 6c90885

Please sign in to comment.