Skip to content

Commit

Permalink
update deps and cleanup readme
Browse files Browse the repository at this point in the history
  • Loading branch information
creeper123123321 committed Jul 10, 2024
1 parent 82dd41f commit a0f9806
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 30 deletions.
34 changes: 7 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ VIAaaS
---

[![ViaVersion Discord](https://img.shields.io/badge/chat-on%20discord-blue.svg)](https://viaversion.com/discord)
[![Powered by ViaVersion](https://img.shields.io/badge/Powered%20by-ViaVersion-blue.svg)](https://viaversion.com/)
[![powered by ViaVersion](https://img.shields.io/badge/powered%20by-ViaVersion-blue.svg)](https://viaversion.com/)


VIAaaS - ViaVersion as a Service - Standalone ViaVersion proxy
Expand All @@ -13,15 +13,7 @@ Address generator: https://jo0001.github.io/ViaSetup/aspirin

Public instances: https://github.com/ViaVersion/VIAaaS/wiki/List-of-Public-Instances

## Demo

Online mode: https://youtu.be/9MKKjuoe66k

Using with GeyserConnect: https://youtu.be/_LItAIIFmsI

Using with GeyserConnect on offline mode: https://youtu.be/-hZESD61nSU

Using with OpenAuthMod: https://youtu.be/h3EfNSxxf8k
## Videos

Offline mode tutorial: https://youtu.be/lPdELnrxmp0

Expand All @@ -30,9 +22,9 @@ Offline mode tutorial: https://youtu.be/lPdELnrxmp0
- [ViaVersion](https://viaversion.com), [ViaBackwards](https://viaversion.com/backwards)
and [ViaRewind](https://viaversion.com/rewind) translates the connections to backend server.
- VIAaaS auth page stores account credentials in the player's browser local storage.
- It requires a CORS Proxy for calling Mojang APIs.
- It uses a CORS Proxy for calling Mojang APIs.
- Account credentials aren't sent to VIAaaS instance by default.
- The web page receives and validates the joinGame's session hash from VIAaaS instance.
- The web page receives and validates the join game request from VIAaaS instance.

## Setting up server instance

Expand All @@ -46,10 +38,9 @@ curl -Lf --output VIAaaS-all.jar "https://jitpack.io/com/github/ViaVersion/VIAaa
java -jar VIAaaS-all.jar
```

- Requires Java 11
- Requires Java 17
- Default Minecraft: ```via.localhost``` with port 25565
- Default HTTPS: ```https://localhost:25543/```
- Default WS URL: ```wss://localhost:25543/ws```

### How to create a public server

Expand All @@ -59,11 +50,6 @@ java -jar VIAaaS-all.jar
- The HTTPS page needs a valid SSL certificate, you can use a reverse proxy like [Apache](https://httpd.apache.org/) (with
a [Let's Encrypt](https://letsencrypt.org/) certificate).

## CORS Proxy

- Due to Mojang API not allowing cross-origin requests, we need to use a CORS proxy
- Note the ending slash in cors-anywhere address

## Usage for players

You'll need to specify which server you want to connect through address parameters
Expand Down Expand Up @@ -102,7 +88,6 @@ Fabric/Forge client:

- ```server.example.net._p25565._v1_12_2._of._uBACKUSERNAME.via.example.com```
- ```server.example.net.v_1_8.via.example.com```
- It's inspired by [Tor2web](https://www.tor2web.org/) proxies.

#### Address parts:

Expand Down Expand Up @@ -156,17 +141,12 @@ Fabric/Forge client:
# The IP address of the remote (Java Edition) server
address: 2b2t.org._v1_12_2.via.localhost
```
- If you are using a public GeyserConnect instance: connect to a publicly available VIAaaS instance,
- If you are using GeyserConnect: connect to a publicly available VIAaaS instance,
like ```mc.example.com._v1_8.via.example.net``` as a Java Edition server.

#### Can I use it to connect to .onion Minecraft hidden servers?

- You can use .onion addresses if the instance is proxying the backend connections to TOR. Note that VIAaaS may log your
requests, and that your DNS queries may be sent unencrypted.

#### Can you support more versions / Is there some alternative?

- See [DirtMultiVersion](https://github.com/DirtPowered/DirtMultiversion) and [ViaProxy](https://github.com/ViaVersion/ViaProxy)
- See [ViaProxy](https://github.com/ViaVersion/ViaProxy)

#### Can I customize the files of HTTP server?

Expand Down
6 changes: 3 additions & 3 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ dependencies {

val vvVer = "5.0.2-SNAPSHOT"
val vbVer = "5.0.2-SNAPSHOT"
val vrVer = "4.0.1-SNAPSHOT"
val vrVer = "4.0.2-SNAPSHOT"
implementation("com.viaversion:viaversion-common:$vvVer") { isTransitive = false }
implementation("com.viaversion:viabackwards-common:$vbVer") { isTransitive = false }
implementation("com.viaversion:viarewind-common:$vrVer") { isTransitive = false }
Expand Down Expand Up @@ -93,10 +93,10 @@ dependencies {
implementation("org.apache.logging.log4j:log4j-iostreams:$log4jVer")
implementation("org.apache.logging.log4j:log4j-jul:$log4jVer")
implementation("org.apache.logging.log4j:log4j-slf4j2-impl:$log4jVer")
implementation("org.jline:jline-terminal-jansi:3.25.1")
implementation("org.jline:jline-terminal-jansi:3.26.1")
implementation("org.slf4j:slf4j-api:$slf4jVer")

val ktorVersion = "2.3.11"
val ktorVersion = "2.3.12"
implementation("io.ktor:ktor-network-tls-certificates-jvm:$ktorVersion")
implementation("io.ktor:ktor-server-websockets:$ktorVersion")
implementation("io.ktor:ktor-server-netty-jvm:$ktorVersion")
Expand Down

0 comments on commit a0f9806

Please sign in to comment.