GMCP Updates, Custom Aliases (#311)

# Changes
* Moved all GMCP functionality to a gmcp module.
* Telnet IAC handlers can be defined by modules
* Module callback added: `OnNetConnect`
* Added custom user aliases:
  * Example: `alias don=equip` - Typing `don` will result in `equip` being executed.
  * Aliases can be more complex, such as `alias gp=give potion` can be used like: `gp dave`, which will expand to: `give potion dave`
* Several new events created for things like health change, xp gains etc.
* Fixed `teleport` admin command for when target room id is `0` or `<0`
* Added `FilePaths.WebDomain` config
* Moved module/plugin callback functions to `Callback` property function recevier.
* Moved contents of `world` file that were mostly empty after so many code changes into world.go, deleted empty files.
* Minor documentation updates
* Added LRU caches for gmcp module data.

Author: Volte6

_datafiles/config.yaml

@@ -182,6 +182,10 @@ Timing:
 #
 ################################################################################
 FilePaths:
+  # - WebDomain -
+  #   This can be mysite.com, or www.mysite.com, etc.
+  #   Do not include the protocol such as http:// or https://
+  WebDomain: "localhost"
   # - WebCDNLocation -
   #   Optional alternative location to serve static files from such as audio
   #   Example: http://files.gomud.net

_datafiles/guides/running/README.md

@@ -4,6 +4,7 @@ These guides assume you want to build from the source. You can also download the
 
 - [Raspberry PI Zero 2W](RASPBERRY-PI.md)
 - [Running via Docker](DOCKER.md)
+- [Setting Up an EC2 Instance](EC2.md)
 
 
 # Quick Start

_datafiles/world/default/templates/help/alias.template

@@ -5,4 +5,7 @@ The <ansi fg="command">alias</ansi> command lists and sets aliases
 <ansi fg="yellow">Usage: </ansi>
 
   <ansi fg="command">alias</ansi> - List all aliases, including system defaults
+
+  <ansi fg="command">alias [name]=[value]</ansi> - Create a custom alias. Left of the '=' is the command, right of the '=' is the replacement.
 
+  <ansi fg="command">alias [name]=</ansi> - Clear an alias (value of [name])

_datafiles/world/default/users/1.yaml

@@ -5,6 +5,8 @@ password: password
 joined: 2024-10-31T13:28:45.395873-07:00
 macros:
   =1: e;e;e;e;e;e;e;e
+aliases:
+  tp: teleport
 character:
   name: AdminAnt
   description: AdminAnt possesses the ability to manipulate the very fabric of the
@@ -63,16 +65,17 @@ character:
     - buffid: 28
       onstartevent: true
       permabuff: true
-      roundcounter: 3
+      roundcounter: 28
       triggersleft: 1000000000
     - buffid: 29
       onstartevent: true
       permabuff: true
-      roundcounter: 11
+      roundcounter: 6
       triggersleft: 1000000000
     - buffid: 39
       onstartevent: false
       permabuff: true
+      roundcounter: 10
       triggersleft: 1000000000
   equipment:
     weapon:

_datafiles/world/empty/templates/help/alias.template

@@ -5,4 +5,7 @@ The <ansi fg="command">alias</ansi> command lists and sets aliases
 <ansi fg="yellow">Usage: </ansi>
 
   <ansi fg="command">alias</ansi> - List all aliases, including system defaults
+
+  <ansi fg="command">alias [name]=[value]</ansi> - Create a custom alias. Left of the '=' is the command, right of the '=' is the replacement.
 
+  <ansi fg="command">alias [name]=</ansi> - Clear an alias (value of [name])

go.mod

@@ -23,6 +23,7 @@ require (
 )
 
 require (
+	github.com/hashicorp/golang-lru/v2 v2.0.7
 	github.com/mattn/go-runewidth v0.0.16
 	github.com/nicksnyder/go-i18n/v2 v2.5.1
 	github.com/pkg/errors v0.9.1

go.sum

@@ -23,6 +23,8 @@ github.com/google/pprof v0.0.0-20230207041349-798e818bf904 h1:4/hN5RUoecvl+RmJRE
 github.com/google/pprof v0.0.0-20230207041349-798e818bf904/go.mod h1:uglQLonpP8qtYCYyzA+8c/9qtqgA3qsXGYqCPKARAFg=
 github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
 github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
+github.com/hashicorp/golang-lru/v2 v2.0.7 h1:a+bsQ5rvGLjzHuww6tVxozPZFVghXaHOwFs4luLUK2k=
+github.com/hashicorp/golang-lru/v2 v2.0.7/go.mod h1:QeFd9opnmA6QUJc5vARoKUSoFhyfM2/ZepoAG6RGpeM=
 github.com/ianlancetaylor/demangle v0.0.0-20220319035150-800ac71e25c2/go.mod h1:aYm2/VgdVmcIU8iMfdMvDMsRAQjcfZSKFby6HOFvi/w=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=

internal/characters/character.go

@@ -1211,6 +1211,7 @@ func (c *Character) ApplyHealthChange(healthChange int) int {
 	}
 
 	c.Health = newHealth
+
 	return newHealth - oldHealth
 }
 
@@ -1291,7 +1292,10 @@ func (c *Character) LevelUp() (bool, stats.Statistics) {
 	return true, statsDelta
 }
 
-func (c *Character) Heal(hp int, mana int) {
+func (c *Character) Heal(hp int, mana int) (int, int) {
+	startHP := c.Health
+	startMP := c.Mana
+
 	c.Health += hp
 	if c.Health > c.HealthMax.Value {
 		c.Health = c.HealthMax.Value
@@ -1300,6 +1304,8 @@ func (c *Character) Heal(hp int, mana int) {
 	if c.Mana > c.ManaMax.Value {
 		c.Mana = c.ManaMax.Value
 	}
+
+	return c.Health - startHP, c.Mana - startMP
 }
 
 func (c *Character) HealthPerRound() int {

internal/configs/config.filepaths.go

@@ -1,6 +1,7 @@
 package configs
 
 type FilePaths struct {
+	WebDomain        ConfigString `yaml:"WebDomain"`
 	WebCDNLocation   ConfigString `yaml:"WebCDNLocation"`
 	DataFiles        ConfigString `yaml:"DataFiles"`
 	PublicHtml       ConfigString `yaml:"PublicHtml"`
@@ -12,6 +13,7 @@ type FilePaths struct {
 
 func (f *FilePaths) Validate() {
 
+	// Ignore WebDomain
 	// Ignore WebCDNLocation
 	// Ignore PublicHtml
 	// Ignore AdminHtml

internal/connections/clientsettings.go

@@ -2,10 +2,7 @@ package connections
 
 type ClientSettings struct {
 	Display DisplaySettings
-	Discord DiscordSettings
 	Client  ClientType // Client data provided by `Core.Hello` GMCP command
-	// Enabled GMCP Modules
-	GMCPModules map[string]int // Enabled GMCP Modules (if any)
 	// Is MSP enabled?
 	MSPEnabled        bool // Do they accept sound in their client?
 	SendTelnetGoAhead bool // Defaults false, should we send a IAC GA after prompts?
@@ -15,10 +12,6 @@ type DisplaySettings struct {
 	ScreenWidth  uint32
 	ScreenHeight uint32
 }
-type DiscordSettings struct {
-	User    string // person#1234
-	Private bool
-}
 
 type ClientType struct {
 	Name     string
@@ -34,14 +27,3 @@ func (c ClientSettings) IsMudlet() bool {
 func (c ClientSettings) IsMsp() bool {
 	return c.MSPEnabled
 }
-
-// Check whether a GMCP module is enabled on the client
-func (c ClientSettings) GmcpEnabled(moduleName string) bool {
-	if len(c.GMCPModules) == 0 {
-		return false
-	}
-
-	_, ok := c.GMCPModules[moduleName]
-
-	return ok
-}