Update to 1.21.0

.github/workflows/release.yml

@@ -0,0 +1,56 @@
+name: Build and Release
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: "1.22.4"
+
+      - name: Build Windows executable
+        run: GOOS=windows GOARCH=amd64 go build -o vanilla-proxy-win.exe .
+
+      - name: Build Linux executable
+        run: GOOS=linux GOARCH=amd64 go build -o vanilla-proxy-linux .
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: v${{ github.run_number }}
+          release_name: Release ${{ github.run_number }}
+          draft: false
+          prerelease: false
+
+      - name: Upload Windows Release Asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./vanilla-proxy-win.exe
+          asset_name: vanilla-proxy-win.exe
+          asset_content_type: application/octet-stream
+
+      - name: Upload Linux Release Asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./vanilla-proxy-linux
+          asset_name: vanilla-proxy-linux
+          asset_content_type: application/octet-stream

.gitignore

@@ -1,2 +1,4 @@
 /whitelist.json
-/config.toml
+/config.toml
+/playerlist.json
+/playerlist.json.lock

.vscode/settings.json

@@ -0,0 +1,24 @@
+{
+    "cSpell.words": [
+        "Debugf",
+        "Debugln",
+        "Errorln",
+        "gophertunnel",
+        "hujson",
+        "iconcache",
+        "Infoln",
+        "logrus",
+        "mathgl",
+        "Overworld",
+        "playerlist",
+        "pokeb",
+        "pokebedrock",
+        "raknet",
+        "Respawn",
+        "Runtimes",
+        "sandertv",
+        "Warnf",
+        "Warnln",
+        "XUID"
+    ]
+}

README.md

@@ -1,32 +1,94 @@
-## How to start a proxy server
-1. Download and install [Go](https://go.dev/dl/)
-2. Download and run Minecraft [Bedrock Dedicated Server](https://www.minecraft.net/en-us/download/server/bedrock).
+> [!WARNING]
+> # This Project has been Archived, and is no longer maintained. For a more up to date proxy, with way more features, please use [GoBDS](https://github.com/smell-of-curry/gobds)
+
+# Vanilla Proxy
+
+Vanilla Proxy is a simple proxy servers that enabled Packet management and protection of BDS server attacks through a end to end proxy system.
+
+## Overview
+
+1. You have all the advantages of the original BDS.
+2. You can modify and cancel any packets passing through the proxy using the handler system.
+3. You can organize the protection of your server from DDOS attacks.
+4. You can set the boards of the world. Blocks outside the border will not be displayed to the player. The coordinates of the corner must be divided by 16 so that the borders are displayed correctly.
+5. Support for a whitelist that can store the player's xbox id(xuid).
+6. A Player List manager that stores a players `SelfSignedID` ensuring as long as a player is signed into a XBL account, they wont get there player reset.
+7. A priority slot system, that allows you to block off specific slots to be restricted for certain players in whitelist.
+
+## Getting Started
 
-```You must set online-mode=false in BDS server.properties```
+> [!IMPORTANT]
+> You must configure BDS `server.properties` to disable `online-mode` and `client-side-chunk-generation-enabled`
 
+1. Download and install [Go](https://go.dev/dl/)
+2. Download and run Minecraft [Bedrock Dedicated Server](https://www.minecraft.net/en-us/download/server/bedrock).
 3. Run in the console:
+
 ```
-git clone https://github.com/HyPE-Network/vanilla-proxy
+git clone https://github.com/smell-of-curry/vanilla-proxy
 cd vanilla-proxy
 go run main.go
 ```
 
->You can also customize config.yml for yourself
+## Configuration
 
-## Overview
-1. You have all the advantages of the original BDS.
-2. You can modify and cancel any packets passing through the proxy using the handler system.
-3. You can organize the protection of your server from ddos attacks.
-4. You can set the boards of the world. Blocks outside the border will not be displayed to the player. The coordinates of the corner must be divided by 16 so that the borders are displayed correctly.
-5. Support for a whitelist that can store the player's xbox id(xuid).
-6. You can use a special bot for Windows with operator capabilities or send commands directly to screen on your Linux server. Screen must have the name of the original server port (for example 19132).
-7. You can use rcon to execute commands automatically (let's say /whitelist add "nickname").
-8. A convenient API for creating forms, commands and fake inventories that are processed on the proxy side.
+Configuration in the Vanilla Proxy is all managed through the [config.toml](config.toml.example). This file holds all details including database, server connection, api, world border and more.
+To get started, copy the [config.toml.example](config.toml.example) file and rename it to `config.toml`. Inside this file you can first set the `Connection` properties.
+
+### Connection
+
+These are the most important as this is what the proxy uses to send the upstream connections too.
+
+- `ProxyAddress` - This is the address that the THIS proxy server will run on. This is the address that you want people to connect too.
+- `RemoteAddress` - This is the address that the BDS server is running on. Ensure that the BDS server is running on a different port.
+
+### Api
+
+This vanilla proxy uses a API to fetch and set players connection details. Details such as connection IP, name, and XUID are saved for moderation capabilities.
+
+- `ApiHost` - This is the API host, something like `https://pokebedrock.com` would work.
+- `ApiKey` - This is a authentication token which will be passed as a password.
+
+### Database
+
+This proxy uses a database to fetch claims, and local player details that are important for operations. This must be managed to ensure the claims work correctly.
+
+- `Host` - This is the host of the database, usually localhost `http://127.0.0.1`
+- `Key` - This is the authentication key, which is passed as a password to ensure a authenticated session.
+- `Name` - This is the database name you want to connect too, it would switch between servers, something like `black`, `white`, `testing` is used.
+- `Port` - This is the database port that the server is running on, which will attach to `Host` when creating a request.
+
+### Logging
+
+This proxy uses a bit of logging so that the discord and the staff team are updated on the server details. Details about sign changes, and failed to ping alerts get sent to discord webhooks to ensure the staff is alerted.
+
+- `DiscordChatLogsWebhook` - this is the endpoint you want chat logs sent too.
+- `DiscordCommandLogsWebhook` - this is the endpoint where when players use commands get sent too.
+- `DiscordSignLogsWebhook` this is the destination for where sign edit logs should be sent.
+- `DiscordStaffAlertsWebhook` - this is a endpoint for staff alerts, things like failed to ping database, etc.
+
+### Resources
+
+This is still a work in progress feature, however this configuration can allow use of custom resource packs to be downloaded by players.
+
+- `PackURLs` - this is a string array of URLs that the players must download and activate to play.
+- `PackPaths` - this is a string array of pack paths that link to a folder that the player must download to play (used for local development).
+
+### Server
+
+Server holds less essential server configuration that changes connection aspects.
+
+- `SecuredSlots` - A count of how many slots to reduce from BDS max player count, that will be reserved for players in the whitelist allowing a priority slot system.
+- `DisableXboxAuth` - specifies if authentication of players that join is disabled. If set to true, no verification will be done to ensure that the player connecting is authenticated using their XBOX Live account.
+- `Prefix` - Prefix is used to specify the current server in error logs. For example `TESTING` would be sent with a logging endpoint to tell readers this came from `TESTING` server.
+- `ViewDistance` - Manages the distance players can view through the chunk handler. This is important for large servers.
+- `Whitelist` - If the whitelist is turned on and limiting players from joining. Whitelist can be managed through the (whitelist.json)[whitelist.json] file.
+- `FlushRate` - The flush rate of the packets, default is `50` == `time.Second / 20`, the lower the value, the more CPU usage.
+
+### WorldBorder
 
-## Examples
-Example of a simple server with survival - [vanilla-survival](https://github.com/HyPE-Network/vanilla-survival)
-> The world has borders, there is a ban on placing obsidian blocks in nether (players can teleport to distant coordinates using nether portals).
-> This prohibition is made by processing the breaking of the block.
+The proxy system comes with a pre-built world border that limits chunks, entities, and ticking from happening outside the world border. This is important for large servers and servers that pregenerate chunks.
 
-## Recommendations
-You can block the BDS server port using a firewall so that unauthorized players cannot enter the main server by bypassing the proxy.
+- `Enabled` - if the world border is enabled.
+- `MaxX` & `MaxZ` - Holds the Max location in the positive direction for the border, example `6000`
+- `MinX` & `MinZ` - Holds the Minimum location in the negative direction for the border, example `-6000`

config.toml.example

@@ -0,0 +1,46 @@
+[Connection]
+ProxyAddress = "0.0.0.0:19132" # The port that players will connect to
+RemoteAddress = "0.0.0.0:19134" # The port that the BDS server is hosted on
+
+[Server]
+Whitelist = true # Whether to enable whitelisting
+SecuredSlots = 5 # The amount of secured slots on the server for only whitelisted players
+ViewDistance = 10 # The view distance for players
+DisableXboxAuth = false # Whether to disable Xbox authentication (This cant be enabled currently)
+FlushRate = 10 # The flush rate for the server
+Prefix = "TESTING" # The prefix for the server, used for logging and discord messages
+
+[WorldBorder]
+Enabled = true # Whether to enable the world border
+MinX = -12000 # The minimum X coordinate for the world border
+MaxX = 12000 # The maximum X coordinate for the world border
+MinZ = -12000 # The minimum Z coordinate for the world border
+MaxZ = 12000 # The maximum Z coordinate for the world border
+
+[Api]
+ApiHost = "https://pokebedrock.com" # The host for the moderation API
+ApiKey = "xxxxxxxx-xxxxxxxx-xxxxxxxx" # The API key for the moderation API
+XboxApiKey = "xxxxxxxx-xxxxxxxx-xxxxxxxx" # The Xbox API key for profile picture fetching
+
+[Resources]
+PackURLs = [] # Urls of resource packs to require downloaded by players
+PackPaths = [] # Paths of resource packs to require downloaded by players
+
+[Database]
+Host = "http://127.0.0.1:3000" # The host for the database
+Key = "xxxxxxxx-xxxxxxxx-xxxxxxxx" # The key for the database
+Name = "testing" # The name of the database (Should be close to Server.Prefix)
+
+[Encryption]
+Key = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # The key for the encryption
+
+[Logging]
+# Enables Discord logging for chat, command and sign logs
+DiscordLoggingEnabled = false
+DiscordChatLogsWebhook = "https://discord.com/api/webhooks/1111111111111111/xxxxxxxx-xxxxxxxx-xxxxxxxx"
+DiscordCommandLogsWebhook = "https://discord.com/api/webhooks/1111111111111111/xxxxxxxx-xxxxxxxx-xxxxxxxx"
+DiscordSignLogsWebhook = "https://discord.com/api/webhooks/1111111111111111/xxxxxxxx-xxxxxxxx-xxxxxxxx"
+DiscordStaffAlertsWebhook = "https://discord.com/api/webhooks/1111111111111111/xxxxxxxx-xxxxxxxx-xxxxxxxx"
+ProfilerHost = "127.0.0.1:19135" # The host for the profiler to view the server performance
+# SentryDsn is optional - remove or leave empty to disable Sentry error tracking
+SentryDsn = "https://[email protected]/xxxxxxx"

custom_handlers/availableCommandsHandler.go

@@ -0,0 +1,80 @@
+package custom_handlers
+
+import (
+	"strings"
+
+	"github.com/HyPE-Network/vanilla-proxy/proxy"
+	"github.com/HyPE-Network/vanilla-proxy/proxy/player/human"
+	"github.com/sandertv/gophertunnel/minecraft/protocol"
+	"github.com/sandertv/gophertunnel/minecraft/protocol/packet"
+)
+
+type AvailableCommandsHandler struct {
+}
+
+type CommandRequestHandler struct {
+}
+
+// RemoveCommands removes a list of specified commands from the list of available commands.
+func RemoveCommands(commands []protocol.Command, remove []string) []protocol.Command {
+	removeMap := make(map[string]bool)
+	for _, cmd := range remove {
+		removeMap[cmd] = true
+	}
+
+	filteredCommands := make([]protocol.Command, 0, len(commands))
+	for _, command := range commands {
+		if !removeMap[command.Name] {
+			filteredCommands = append(filteredCommands, command)
+		}
+	}
+
+	return filteredCommands
+}
+
+func (AvailableCommandsHandler) Handle(pk packet.Packet, player human.Human) (bool, packet.Packet, error) {
+	dataPacket := pk.(*packet.AvailableCommands)
+
+	// Define an array of command names to remove
+	commandsToRemove := []string{"me", "tell"}
+	dataPacket.Commands = RemoveCommands(dataPacket.Commands, commandsToRemove)
+
+	proxy.ProxyInstance.Worlds.SetBDSAvailableCommands(dataPacket)
+
+	return true, dataPacket, nil
+}
+
+func (CommandRequestHandler) Handle(pk packet.Packet, player human.Human) (bool, packet.Packet, error) {
+	dataPacket := pk.(*packet.CommandRequest)
+	playerData := player.GetData().GameData
+
+	var command = strings.ToLower(strings.Split(dataPacket.CommandLine[1:], " ")[0])
+
+	if command == "me" || command == "tell" || command == "w" || command == "msg" {
+		player.SendMessage("§cThe command /" + command + " is disabled!")
+		player.PlaySound("note.bass", playerData.PlayerPosition, 1, 1)
+		return false, pk, nil
+	}
+
+	minecraftCommands := proxy.ProxyInstance.Worlds.BDSAvailableCommands.Commands
+	// Check if {command} is a name inside {minecraftCommands}
+	for _, cmd := range minecraftCommands {
+		if cmd.Name == command {
+			return true, pk, nil
+		}
+	}
+
+	// Command should be a custom `-` command
+	textPk := &packet.Text{
+		TextType:         packet.TextTypeChat,
+		NeedsTranslation: false,
+		SourceName:       player.GetName(),
+		Message:          "-" + strings.TrimPrefix(dataPacket.CommandLine, "/"),
+		Parameters:       []string{},
+		XUID:             player.GetSession().IdentityData.XUID,
+		PlatformChatID:   "",
+	}
+	player.DataPacketToServer(textPk)
+
+	return false, dataPacket, nil
+}

custom_handlers/chatLogging.go

@@ -0,0 +1,49 @@
+package custom_handlers
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/HyPE-Network/vanilla-proxy/proxy"
+	"github.com/HyPE-Network/vanilla-proxy/proxy/player/human"
+	"github.com/HyPE-Network/vanilla-proxy/utils"
+	"github.com/sandertv/gophertunnel/minecraft/protocol/packet"
+)
+
+type ChatLoggingHandler struct{}
+
+func (h ChatLoggingHandler) Handle(pk packet.Packet, player human.Human) (bool, packet.Packet, error) {
+	dataPacket := pk.(*packet.Text)
+
+	// Only care if player is sending message
+	if dataPacket.TextType != packet.TextTypeChat {
+		return true, pk, nil
+	}
+
+	// Check if its a packet from the client
+	if dataPacket.SourceName != player.GetName() {
+		return true, pk, nil
+	}
+
+	// Ignore commands
+	if strings.HasPrefix(dataPacket.Message, "-") || strings.HasPrefix(dataPacket.Message, "/") {
+		return true, pk, nil
+	}
+
+	avatar_url, err := utils.GetXboxIconLink(player.GetSession().IdentityData.XUID, proxy.ProxyInstance.Config.Api.XboxApiKey)
+	if err != nil {
+		avatar_url = "https://media.forgecdn.net/avatars/121/268/636409261203329160.png"
+	}
+
+	// Log message to discord.
+	utils.SendJsonToDiscord(proxy.ProxyInstance.Config.Logging.DiscordChatLogsWebhook, map[string]any{
+		"username":   fmt.Sprintf("[%s] %s", proxy.ProxyInstance.Config.Server.Prefix, player.GetName()),
+		"avatar_url": avatar_url,
+		"content":    dataPacket.Message,
+		"allowed_mentions": map[string]any{
+			"parse": []string{},
+		},
+	})
+
+	return true, pk, nil
+}