feat(munch): ⭐

Author: Fuwn

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -0,0 +1,15 @@
+# IDE
+/.idea/
+/munch.iml
+
+# Artifacts
+/*.exe
+/*.exe~
+/*.dll
+/*.so
+/*.dylib
+/*.test
+/*.out
+
+# Development
+/config.yml

LICENSE

@@ -0,0 +1,8 @@
+fmt:
+	go fmt github.com/Whirlsplash/munch...
+
+run: fmt
+	go run munch.go
+
+build: fmt
+	go build

Makefile

@@ -0,0 +1,59 @@
+:code:`munch`
+=====
+
+A means of facilitating Worlds-to-Discord (and back) communication
+
+Synopsis
+--------
+
+Currently, Munch is no more than a simple proof-of-concept of how a dummy
+account can connect to a WorldServer and intercept information.
+
+Planned Features:
+
+- Worlds communication transmitted to Discord
+- Discord communication transmitted to Worlds
+- Webhook support
+
+Once stable, the features of Munch will be integrated into the
+`Whirlsplash Discord bot <https://github.com/Whirlsplash/bot>`_.
+
+Limitations
+^^^^^^^^^^^
+
+Munch never sends any positional information to the RoomServer once connected,
+this means that she is never rendered as an avatar, this also means that she is
+technically never present within a room (?) so she cannot intercept TEXT
+commands, this will be fixed (keep in mind, this is just a proof-of-concept).
+
+Notes
+^^^^^
+
+Munch also paves the way for a system of bots enabled by the
+Whirlsplash-of-things. "What? ..."; Whirlsplash is planned to have an imperative
+"programming" language of sorts which can be used to create bots for Whirl with
+ease.
+
+Development
+-----------
+
+Docker support coming soon!
+
+Running
+^^^^^^^
+
+.. code-blocK:: shell
+
+  $ make run
+
+Building
+^^^^^^^^
+
+.. code-blocK:: shell
+
+  $ make build
+
+License
+~~~~~~~
+
+`GNU General Public License v3.0 <./LICENSE>`_

README.rst

@@ -0,0 +1,9 @@
+worlds:
+  server: # These shouldn't change
+    ip: 209.240.84.122
+    port: 6650
+
+  account: # Change this to a spare (or main?) account's login information
+    username: fuwn
+    password: somethingsecure22
+    avatar: Vamp.mov

config.example.yml

@@ -0,0 +1,5 @@
+module github.com/Whirlsplash/munch
+
+go 1.16
+
+require github.com/spf13/viper v1.8.1

go.mod

@@ -0,0 +1,14 @@
+// Copyright (C) 2021-2021 The Whirlsplash Collective
+// SPDX-License-Identifier: GPL-3.0-only
+
+package main
+
+import (
+	"github.com/Whirlsplash/munch/pkg/config"
+	"github.com/Whirlsplash/munch/pkg/server"
+)
+
+func main() {
+	config.Setup()
+	server.Do()
+}

go.sum

@@ -0,0 +1,25 @@
+// Copyright (C) 2021-2021 The Whirlsplash Collective
+// SPDX-License-Identifier: GPL-3.0-only
+
+package config
+
+import (
+	"github.com/spf13/viper"
+	"log"
+)
+
+func Setup() {
+	viper.SetConfigName("config.yml")
+	viper.SetConfigType("yaml")
+	viper.AddConfigPath(".")
+
+	if err := viper.ReadInConfig(); err != nil {
+		if _, ok := err.(viper.ConfigFileNotFoundError); ok {
+			log.Panicln("Cannot read configuration file:", err)
+		} else {
+			log.Panicln("Read configuration file but an error occurred anyway:", err)
+		}
+	}
+
+	viper.WatchConfig()
+}

munch.go

@@ -0,0 +1,58 @@
+// Copyright (C) 2021-2021 The Whirlsplash Collective
+// SPDX-License-Identifier: GPL-3.0-only
+
+package server
+
+import (
+	"encoding/binary"
+	"github.com/Whirlsplash/munch/pkg/server/utils"
+	"github.com/spf13/viper"
+	"log"
+	"net"
+	"strconv"
+)
+
+func doDistributor() string {
+	tcpAddr, _ := net.ResolveTCPAddr(
+		"tcp",
+		viper.GetString("worlds.server.ip")+":"+viper.GetString("worlds.server.port"),
+	)
+	conn, _ := net.DialTCP("tcp", nil, tcpAddr)
+
+	// PROPREQ
+	conn.Write([]byte("\x03\xff\x0a"))
+	reply := make([]byte, 1024)
+	conn.Read(reply)
+	log.Println("AutoServer: PROPREQ")
+
+	// SESSINIT
+	conn.Write(utils.EncodeSessionInitialization(
+		viper.GetString("worlds.account.username"),
+		viper.GetString("worlds.account.password"),
+		utils.AutoServer,
+	))
+	reply = make([]byte, 1024)
+	conn.Read(reply)
+	log.Println("AutoServer: SESSINIT")
+
+	// PROPUPD
+	conn.Write(utils.EncodePropertyUpdate(viper.GetString("worlds.account.avatar")))
+	reply = make([]byte, 1024)
+	conn.Read(reply)
+	log.Println("AutoServer: PROPUPD")
+
+	// ROOMIDRQ
+	conn.Write([]byte(
+		"\x26\x01\x14\x22\x47\x72\x6f\x75\x6e\x64\x5a\x65\x72\x6f\x23\x73" +
+			"\x74\x61\x69\x72\x63\x61\x73\x65\x31\x3c\x64\x69\x6d\x65\x6e\x73" +
+			"\x69\x6f\x6e\x2d\x31\x3e",
+	))
+	reply = make([]byte, 1024)
+	conn.Read(reply)
+	port := strconv.Itoa(int(binary.BigEndian.Uint16(reply[44:46])))
+	log.Println("AutoServer: ROOMIDRQ")
+
+	conn.Close()
+
+	return port
+}

pkg/config/config.go

@@ -0,0 +1,70 @@
+// Copyright (C) 2021-2021 The Whirlsplash Collective
+// SPDX-License-Identifier: GPL-3.0-only
+
+package server
+
+import (
+	"github.com/Whirlsplash/munch/pkg/server/utils"
+	"github.com/spf13/viper"
+	"log"
+	"net"
+)
+
+func doHub(port string) {
+	tcpAddr, _ := net.ResolveTCPAddr(
+		"tcp",
+		(viper.GetString("worlds.server.ip") + ":" + port),
+	)
+	conn, _ := net.DialTCP("tcp", nil, tcpAddr)
+
+	// PROPREQ
+	conn.Write([]byte("\x03\xff\x0a"))
+	reply := make([]byte, 1024)
+	conn.Read(reply)
+	log.Println("RoomServer: PROPREQ")
+
+	// SESSINIT
+	conn.Write(utils.EncodeSessionInitialization(
+		viper.GetString("worlds.account.username"),
+		viper.GetString("worlds.account.password"),
+		utils.RoomServer,
+	))
+	reply = make([]byte, 1024)
+	conn.Read(reply)
+	log.Println("RoomServer: SESSINIT")
+
+	// SUB-DIST
+	conn.Write([]byte(
+		"\x0d\x01\x16\x00\x02\x00\x00\x00\xfa\x00\x00\x0a\xf8" +
+			"\x0d\x01\x16\x00\x01\x00\x00\x02\xee\x00\x00\x0c\xf9" +
+			"\x0d\x01\x16\x00\x07\x00\x00\x36\xaf\x00\x00\x09\xbd" +
+			"\x0d\x01\x16\x00\x06\xf1\x77\x00\x00\x01\x90\x0d\xcf\x0d\x01\x16" +
+			"\x98\xee\x00\x00\x00\xc8\x00\x28\x0e\x67\x0d\x01\x16\x00\x04\x00" +
+			"\x00\x00\xfa\x00\x00\x0c\xb7\x0d\x01\x16\x00\x03\x00\x00\x02\xee" +
+			"\x00\x00\x0c\x30\x0d\x01\x16\x00\x09\x01\xf4\x03\xe8\x01\xf4\x09" +
+			"\xd5\x0d\x01\x16\x00\x08\x00\x00\x00\x00\x00\x00\xff\x9c\x0f\x01" +
+			"\x12\x00\x08\x00\x01\x04\xcc\x09\xa1\x00\x00\x01\x25\x07\x01\x18" +
+			"\x00\x01\x0c\xf9\x07\x01\x18\x00\x03\x0c\x30\x07\x01\x18\x00\x09" +
+			"\x09\xd5\x07\x01\x18\x00\x07\x09\xbd\x07\x01\x18\x00\x06\x0d\xcf" +
+			"\x07\x01\x18\x98\xee\x0e\x67\x07\x01\x18\x00\x04\x0c\xb7\x07\x01" +
+			"\x18\x00\x02\x0a\xf8",
+	))
+	reply = make([]byte, 1024)
+	conn.Read(reply)
+	log.Println("RoomServer: SUBSCRIB")
+
+	// Listen for whispers
+	for {
+		reply = make([]byte, 1024)
+		conn.Read(reply)
+		if reply[2] == 17 {
+			decodedText := utils.DecodeText(reply)
+			log.Printf(
+				"RoomServer: WHISPER: %s: %s\n",
+				decodedText.Author, decodedText.Message,
+			)
+		}
+	}
+
+	conn.Close()
+}

pkg/server/distributor.go

@@ -0,0 +1,10 @@
+// Copyright (C) 2021-2021 The Whirlsplash Collective
+// SPDX-License-Identifier: GPL-3.0-only
+
+package server
+
+func Do() {
+	// The Distributor isn't actually needed for Munch to work, the only reason
+	// that we use it is because it gives us the correct Hub port to connect to.
+	doHub(doDistributor())
+}

pkg/server/hub.go

@@ -0,0 +1,24 @@
+// Copyright (C) 2021-2021 The Whirlsplash Collective
+// SPDX-License-Identifier: GPL-3.0-only
+
+package utils
+
+import "strconv"
+
+type Text struct {
+	Author  string
+	Message string
+}
+
+// Decode a TEXT command from hexadecimal to a Text struct
+func DecodeText(data []byte) Text {
+	authorLength, _ := strconv.ParseInt(strconv.Itoa(int(data[4])), 16, 32)
+	authorLast := authorLength + 5
+	messageLength, _ := strconv.ParseInt(strconv.Itoa(int(data[authorLast])), 16, 32)
+	messageStart := authorLast + 1
+
+	return Text{
+		Author:  string(data[5:(authorLast)]),
+		Message: string(data[messageStart : messageStart+(messageLength)]),
+	}
+}

pkg/server/server.go

@@ -0,0 +1,70 @@
+// Copyright (C) 2021-2021 The Whirlsplash Collective
+// SPDX-License-Identifier: GPL-3.0-only
+
+package utils
+
+const (
+	AutoServer = iota
+	RoomServer
+)
+
+func EncodeSessionInitialization(username string, password string, serverType int) []byte {
+	data := ""
+
+	// Data length
+	if serverType == AutoServer {
+		data += "\x2b"
+	} else {
+		data += "\x2c"
+	}
+
+	// Command header and other stuff we don't need to worry about
+	data += "\x01\x06\x03\x02\x32\x34\x09\x0a\x32\x30\x32\x30\x30\x33\x31" +
+		"\x32\x30\x30"
+
+	if serverType == RoomServer {
+		data += "\x07\x02\x32\x34"
+	}
+
+	data +=
+		// Username
+		"\x02" + string(rune(len(username))) + ISO88591ToString(username) +
+
+			// Password
+			"\x06" + string(rune(len(password))) + ISO88591ToString(password)
+
+	if serverType == AutoServer {
+		data += "\x0c\x01\x31"
+	}
+
+	return []byte(data)
+}
+
+func EncodeBuddyListUpdate(buddy string) []byte {
+	// Command header
+	data := "\x01\x1d"
+
+	// Buddy UTF-8 length and UTF-8
+	data += string(rune(len(buddy))) + ISO88591ToString(buddy)
+
+	// Buddy "add"
+	data += "\x01"
+
+	// Data length
+	data = (string(rune(len(data) + 1))) + data
+
+	return []byte(data)
+}
+
+func EncodePropertyUpdate(avatar string) []byte {
+	// Command header and extra stuff we don't need to worry about
+	data := "\x01\x0f\x00\x05\x40\x01"
+
+	// Avatar UTF-8 length and UTF-8
+	data += string(rune(len("avatar:"+avatar))) + ISO88591ToString("avatar:"+avatar)
+
+	// Data length
+	data = (string(rune(len(data) + 1))) + data
+
+	return []byte(data)
+}