feat: status place holder

cmd/infrared/main.go

@@ -75,6 +75,8 @@ func initLogger() {
 	log.Debug().
 		Str("level", logLevel).
 		Msg("Log level set")
+
+	ir.Log = log.Logger
 }
 
 func main() {
@@ -104,7 +106,6 @@ func run() error {
 		ConfigPath:  configPath,
 		ProxiesPath: proxiesDir,
 	})
-	srv.Logger = log.Logger
 
 	errChan := make(chan error, 1)
 	go func() {

configs/config.yml

@@ -40,4 +40,37 @@ filters:
 
     # Windows Length is the time frame for the Request Limit.
     #
-    windowLength: 1s
+    windowLength: 1s
+
+# Reponse that the player sees when there is no server for that domain.
+#
+notFoundResponse:
+  # The status response that should be displayed to the players
+  #
+  status:
+
+    # The name of the version.
+    # This is displayed on the client side when the version is incompatible.
+    #
+    versionName: "Infrared 1.20.6"
+
+    # The protocol version number determens if the version of the client is compatible with the server.
+    # A list of protocol versions can be found here: https://wiki.vg/Protocol_version_numbers
+    # Set this to -1 to mirror the client version back.
+    #
+    protocolNumber: -1
+    maxPlayerCount: 0
+    playerCount: 0
+    playerSamples: []
+
+    # Server icon can be provided as base64 or path to a file.
+    #
+    icon: ""
+
+    # MOTD can be just a string or a JSON Text Component.
+    #
+    motd: "Server not found"
+
+  # Reason why the player was disconnected during login.
+  #
+  message: "Server not found"

configs/proxy.yml

@@ -13,4 +13,30 @@ addresses:
 # Send a PROXY Protocol Header to the server to
 # forward the players IP address
 #
-#sendProxyProtocol: true
+#sendProxyProtocol: true
+
+# Reponse that the player sees when the connection to the backend server
+# times out during status or login request.
+#
+dialTimeoutResponse:
+  status:
+    versionName: "Infrared 1.20.6"
+    protocolNumber: 766
+    maxPlayerCount: 20
+    playerCount: 0
+    playerSamples: []
+    icon: ""
+    motd: "Unable to reach backend server"
+  message: "Unable to reach backend server"
+
+# Override Status is similar to the dial timeout response status
+# but instead you just can override some fields in the status.
+#
+overrideStatus:
+  versionName: "1.20.6"
+  protocolNumber: 766
+  maxPlayerCount: 20
+  playerCount: 0
+  playerSamples: []
+  icon: ""
+  motd: "Unable to reach backend server"

docs/.vitepress/config.mts

@@ -3,8 +3,7 @@ import { defineConfig} from 'vitepress'
 export default defineConfig({
   lang: 'en-US',
   title: 'Infrared',
-  titleTemplate: ':title | Minecraft Proxy',
-  description: 'Minecraft Proxy',
+  description: 'The Minecraft Reverse Proxy',
   cleanUrls: true,
   head: [
     [

docs/community-projects.md

@@ -1,12 +1,12 @@
 # Community Projects
 
 > [!NOTE]
-> These projects are managed by the Infrared Community.
+> These projects are managed by the Community.
 > We do **not** provide official support for these projects.
 > Please use their dedicated issue trackers or support channels provided by the respective project.
 > Thanks for understanding.
 
-## Infrared for Pterodactyl
+## Pterodactyl Egg
 
 An egg to run Infrared in Pterodactyl. \
 Repo: [Shadowner/Infrared-Pterodactyl-egg](https://github.com/Shadowner/Infrared-Pterodactyl-egg) \

docs/config/server-status.md

@@ -0,0 +1,4 @@
+# Server Status
+
+The server status is what the server sends to clients to display in the server list.
+

docs/faq.md

@@ -0,0 +1,6 @@
+# FAQ
+
+## Will you add (Query)[https://wiki.vg/Query]?
+
+No, it is fundamentally not compatibale with reverse proxies.
+

docs/features/status-cache.md

@@ -0,0 +1,10 @@
+# Status Cache
+
+The status cache aims to reduces the ping frequency and the general load on your backend servers and Infrared.
+It is implemented by via a double hash map to reduce it's memory footprint.
+
+## Enable Status Caching
+
+```yaml
+
+```

docs/getting-started.md

@@ -27,9 +27,9 @@ The URL of your download should look something like this:
 ```
 https://github.com/haveachin/infrared/releases/download/{version}/infrared_{architecture}.tar.gz
 ```
-For example:
+For latest:
 ```
-https://github.com/haveachin/infrared/releases/download/v1.3.4/infrared_Linux_x86_64.tar.gz
+https://github.com/haveachin/infrared/releases/latest/download/infrared_Linux_x86_64.tar.gz
 ```
 
 ::: tip
@@ -43,7 +43,7 @@ curl -LO https://github.com/haveachin/infrared/releases/download/{version}/infra
 
 Downloading by using Powershell on Windows:
 ```Powershell
-Invoke-WebRequest -Uri https://github.com/haveachin/infrared/releases/download/v1.3.4/infrared_Windows_x86_64.zip -OutFile c:\infrared.zip
+Invoke-WebRequest -Uri https://github.com/haveachin/infrared/releases/latest/download/infrared_Windows_x86_64.zip -OutFile c:\infrared.zip
 ```
 
 ### Extracting the binary