diff --git a/README.md b/README.md index 2e47e4d..bcb2269 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ VIAaaS VIAaaS - ViaVersion ~~acetylsalicylic acid~~ as a Service - Standalone ViaVersion proxy ## How does it work? +- ViaVersion, ViaBackwards and ViaRewind translates the connections to backend server. - VIAaaS auth page stores account credentials in the player's browser local storage. - Due to technical/security reasons, it requires a CORS Proxy for calling Mojang APIs, which may make Mojang see that as suspicious and reset/block your account password if the IP address seems suspect. @@ -14,8 +15,10 @@ VIAaaS - ViaVersion ~~acetylsalicylic acid~~ as a Service - Standalone ViaVersio Download: [GitHub Actions](https://github.com/ViaVersion/VIAaaS/actions) (needs to be logged into GitHub) or [JitPack](https://jitpack.io/com/github/viaversion/viaaas/master-SNAPSHOT/viaaas-master-SNAPSHOT-all.jar) How to start VIAaaS server: +```sh +java -jar VIAaaS-all.jar +``` - Requires Java 11 -- ```java -jar VIAaaS-all.jar``` - Default Minecraft: ```viaaas.localhost``` with port 25565 - Default WS URL: ```wss://localhost:25543/ws``` @@ -24,20 +27,24 @@ How to start VIAaaS server: - Note the ending slash in cors-anywhere address Setting up [cors-anywhere](https://www.npmjs.com/package/cors-anywhere) on local machine: -- ```git clone https://github.com/Rob--W/cors-anywhere && cd cors-anywhere && npm install && node server.js``` +```sh +git clone https://github.com/Rob--W/cors-anywhere +cd cors-anywhere +npm install +node server.js +``` - It will be available at ```http://localhost:8080/``` My cors-anywhere instance: -- If you trust me, you can use https://crp123-cors.herokuapp.com/ +- If you trust me, you can use https://crp123-cors.herokuapp.com/ ([source](https://github.com/creeper123123321/cors-anywhere/)) ## Usage for players Usage for offline mode: - Connect to ```mc.example.com.viaaas.localhost``` Usage for online mode: -- You can use two accounts (avoids Bad Login error), the same account for front-end and back-end connections, or use ```_of``` - (offline mode in frontend, unencrypted and no username verification). -- Go to VIAaaS auth webpage (https://localhost:25543/) +- You can use two accounts (avoids Bad Login error), the same account for front-end and back-end connections, or use ```_of``` (offline mode in frontend, unencrypted and with no username verification). +- Go to [VIAaaS auth webpage](https://localhost:25543/) - Configure CORS proxy, see above in "CORS Proxy" section - Listen to the username A you'll use to connect to the proxy. - Add the account B to VIAaaS page which you'll use in ```_u(account B)``` parameter below. @@ -46,7 +53,7 @@ Usage for online mode: - If you use the same online mode account, your client will show Bad Login. You can use a mod like [Auth Me](https://www.curseforge.com/minecraft/mc-mods/auth-me) or [ReAuth](https://www.curseforge.com/minecraft/mc-mods/reauth) for reauthenticating the client. -Example address: ```server.example.com._p25565._v1_12_2._ofalse._uBACKUSERNAME.viaaas.example.com``` (similar to [Tor2web](https://www.tor2web.org/) proxies) +Example address: ```server.example.com._p25565._v1_12_2._of._uBACKUSERNAME.viaaas.example.com``` (similar to [Tor2web](https://www.tor2web.org/) proxies) Address parts: - ```server.example.com```: backend server address