repository·master·Indexed 41 days ago
https://github.com/ao-data/albiondata-clientA distributed client that monitors local network traffic for Albion Online UDP packets and forwards the extracted data to a central NATS server. It includes a GUI dashboard built with Wails, Go, and Svelte, and provides a Go library (`albiondata-client/lib`) containing structs for processing and validating the project's JSON uploads.
albiondata-client/lib package provides the necessary Go structs required to process and work with JSON uploads generated by the Albion Data client. Use these structs to deserialize or validate the JSON data format used by the project.The Svelte-based dashboard is organized into three main sections:
The Wails v3 dashboard app is designed to open automatically upon launch. To prevent an initial-paint flash on Windows, the window is initialized with Hidden: true and only becomes visible and focused once the ApplicationStarted event fires. This ensures the window is fully realized before being shown.
On macOS, the app uses ActivationPolicyAccessory, so the dashboard explicitly calls Focus() after becoming visible to ensure it appears in front of other active applications.
The dashboard uses an activity heartbeat to track whether the client is actively capturing data. Instead of relying on the network watcher's liveness, the system now uses RecordActivity() to mark successful packet decoding.
When RecordActivity() is called, CaptureRunning is set to true. A background goroutine (the staleness ticker) periodically checks the time since the last activity. If the time elapsed exceeds CaptureStaleAfter, CaptureRunning is set to false.
Key configuration variables (overridable in tests):
CaptureStaleAfter: Duration of inactivity before the status becomes stale (default 30s).StaleCheckInterval: Frequency of the staleness check (default 5s).// Example of how activity is recorded during packet decoding
if err == nil {
dashboard.RecordActivity()
}The albiondata-client uses the startUpdater() function (defined in albiondata-client.go) to poll for updates hourly via github.com/ao-data/go-githubupdate.
Important constraints:
version string is not empty and does not contain the substring dev. Dev builds (the default when using scripts/run.sh or buildall_main.sh) will never check for updates.The dashboard's capturing status badge reflects real-time game traffic rather than just the liveness of the client process.
OperationRequest, OperationResponse, or EventData) is detected.Status.CaptureError).This plan outlines the implementation of automatic dashboard launching and Windows console visibility management.
internal/console package wraps WinAPI calls to hide/show the process's console window. This package uses build-tag-splitting to provide no-op stubs on non-Windows platforms, allowing callers to use it without manual runtime.GOOS checks.showDashboardWindow() helper. This is preferred over the Wails Hidden option because showDashboardWindow() uses InvokeSync(w.Run) to force synchronous window realization, preventing race conditions during the Wails startup sequence.console.Supported(), which returns true only on Windows.len(os.Args) == 1). This ensures that command-line flags (e.g., -version, -h) remain visible in the console.On Windows, the application manages the visibility of the console window to provide a cleaner user experience.
-version, -h, or -debug), the console remains visible so that flag output is readable.When running on Windows, a toggle item is added to the system tray menu. This item allows users to manually show or hide the console window. The menu item label dynamically updates (e.g., switching between "Show Console" and "Hide Console") based on the current visibility state.
The frontend is built with Svelte 5 (using runes) and Vite.
Key UI Components:
App.svelte: The top-level layout. It defines the global design tokens via CSS variables (e.g., --bg, --blue, --font-display).lib/Sidebar.svelte: Contains the status badge, server/version info, and the CountersPanel.lib/CountersPanel.svelte: Displays counters as a vertical label/value list within the sidebar.lib/LogTail.svelte: A scrolling log view. It automatically linkifies http(s):// URLs and specific data identifiers. An identifier is recognized if it follows the literal prefix "Identifier: " (e.g., Identifier: <uuid>), which links to albion-online-data.com/identifier?identifier=<uuid>.lib/Footer.svelte: Contains external links (Project site, Discord).Design Guidelines:
--bg, --blue) instead of inventing new colors.--ember (error/red) and --moss (success/green) are reserved for semantic status and should not be part of general palette swaps.Browser.OpenURL to open in the user's system browser rather than navigating within the webview.The project follows a strict single-file build convention for the main package. All build scripts (e.g., scripts/build-windows.sh, scripts/run.sh, buildall_main.sh) invoke the compiler by targeting a specific file rather than the package directory:
go build ... albiondata-client.go
Rules for adding code to the root:
.go file directly in the repository root if it belongs to package main..go files in the root will be ignored by the build scripts, leading to undefined: linker errors.main function requires new logic or dependencies, place that code in an internal/ package and import it normally.go build ... albiondata-client.goThe dashboard's Server field displays a 'Private' label if the user has configured a custom ingest URL via the -i flag.
Technically, PrivateIngest is set to true whenever the configuration value for client.ConfigGlobal.PublicIngestBaseUrls is not equal to the default string: https+pow://albion-online-data.com. This value is computed once at startup and is not recomputed during runtime.