amacocian/Daybreak
1
0
Fork 0
mirror of https://github.com/gwdevhub/Daybreak.git synced 2026-09-13 20:09:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
release/0.9.10.22
Daybreak/README.md
T

260 lines
8.6 KiB
Markdown
Raw Permalink Blame History

# Daybreak
![Daybreak launcher][screenshot]
Custom launcher for Guild Wars.
## Download
- Go to [Releases](https://github.com/AlexMacocian/Daybreak/releases/latest)
- Download daybreakv[VERSION].zip, where [VERSION] is the version of the release
## Features
Please check the [wiki](https://github.com/AlexMacocian/Daybreak/wiki) for
project description and features.
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for the branching model and release
process.
______________________________________________________________________
## Architecture Overview
Daybreak is a cross-platform application built with .NET 10 and Photino.Blazor.
The launcher provides a native UI on each platform while sharing the majority of
business logic through a common core library.
### Project Structure
```mermaid
graph TB
subgraph "Platform Executables"
WIN[Daybreak.Windows<br/><i>win-x64</i>]
LNX[Daybreak.Linux<br/><i>linux-x64</i>]
end
subgraph "Shared Libraries"
CORE[Daybreak.Core<br/><i>net10.0 / net10.0-windows</i>]
SHARED[Daybreak.Shared<br/><i>net10.0</i>]
end
subgraph "Native AOT Subprojects (Windows)"
INJ[Daybreak.Injector<br/><i>win-x86, NativeAOT</i>]
API[Daybreak.API<br/><i>win-x86, NativeAOT</i>]
INST[Daybreak.Installer<br/><i>win-x64, NativeAOT</i>]
end
subgraph "Other"
TESTS[Daybreak.Tests]
PLUGINS[Example Plugins]
end
WIN --> CORE
LNX --> CORE
CORE --> SHARED
INJ --> SHARED
API --> SHARED
TESTS --> CORE
PLUGINS -.-> SHARED
```
### Component Descriptions
| Project | Description |
| ---------------------- | ---------------------------------------------------------------------------------------------- |
| **Daybreak.Windows** | Windows executable with WebView2, MSAL authentication, shortcuts, and native screen management |
| **Daybreak.Linux** | Linux executable using GTK/WebKit via Photino, with Wine-based game injection |
| **Daybreak.Core** | Shared Blazor UI, services, and configuration (multi-targeted for Windows-specific features) |
| **Daybreak.Shared** | Common models, utilities, and interfaces used across all projects |
| **Daybreak.Injector** | NativeAOT x86 executable that injects DLLs into the Guild Wars process |
| **Daybreak.API** | NativeAOT x86 library injected into Guild Wars, exposes game data via WebSocket/REST |
| **Daybreak.Installer** | Standalone installer/updater executable |
______________________________________________________________________
## Build Requirements
### Windows
- .NET 10 SDK
- ASP.NET Core Runtime
- WebView2 Runtime (<https://go.microsoft.com/fwlink/p/?LinkId=2124703>)
### Linux
#### Arch
```bash
sudo pacman -S dotnet-sdk aspnet-runtime
```
#### Ubuntu/Debian
```bash
# Add Microsoft package repository
wget https://packages.microsoft.com/config/ubuntu/$(lsb_release -rs)/packages-microsoft-prod.deb \
-O packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
rm packages-microsoft-prod.deb
# Install .NET SDK and ASP.NET Core runtime
sudo apt update
sudo apt install -y dotnet-sdk-10.0 aspnetcore-runtime-10.0
```
#### Fedora
```bash
sudo dnf install dotnet-sdk-10.0 aspnetcore-runtime-10.0
```
#### Verify Installation
```bash
dotnet --list-sdks
dotnet --list-runtimes
```
### Linux Runtime Requirements
In addition to .NET, the following are required to run Daybreak on Linux:
- **GTK 3** and **WebKitGTK** (for Photino)
- **Wine** (for running the Windows-based injector and Guild Wars)
______________________________________________________________________
## Wine Integration (Linux)
On Linux, Daybreak uses Wine to run the Windows-based `Daybreak.Injector.exe`
and Guild Wars itself. This section documents the architecture and
implementation plan.
### Architecture
```mermaid
graph LR
subgraph "Linux (Native)"
UI[Daybreak.Linux<br/><i>Photino/GTK</i>]
INJ_L[DaybreakInjector<br/><i>Linux impl</i>]
WPM[WinePrefixManager]
end
subgraph "Wine Prefix"
WINE[wine]
INJ_W[Daybreak.Injector.exe<br/><i>x86</i>]
GW[Gw.exe]
API[Daybreak.API.dll]
end
UI --> INJ_L
INJ_L --> WPM
WPM --> WINE
WINE --> INJ_W
INJ_W -->|launches suspended| GW
INJ_W -->|injects| API
```
### Wine Prefix Management
Daybreak manages a single dedicated Wine prefix for all Wine operations. This is
handled by `IWinePrefixManager`:
```csharp
public interface IWinePrefixManager
{
/// <summary>
/// Checks if Wine is installed and available on the system.
/// </summary>
bool IsAvailable();
/// <summary>
/// Initializes the Wine prefix if it doesn't exist (wineboot --init).
/// </summary>
Task Install(CancellationToken cancellationToken);
/// <summary>
/// Returns the path to Daybreak's Wine prefix directory.
/// </summary>
string GetWinePrefixPath();
/// <summary>
/// Launches a Windows executable through Wine with the managed prefix.
/// </summary>
Task<(string? Output, string? Error, int ExitCode)> LaunchProcess(
string exePath,
string workingDirectory,
string[] arguments,
CancellationToken cancellationToken);
}
```
### Path Translation
Wine exposes the Linux filesystem through the `Z:` drive. The `PathUtils` class
provides a method to convert native Linux paths to Wine-compatible paths:
| Linux Path | Wine Path |
| ----------------------------------------------------- | ------------------------------------------------------- |
| `/mnt/games/Guild Wars/Gw.exe` | `Z:/mnt/games/Guild Wars/Gw.exe` |
| `/home/user/.daybreak/Injector/Daybreak.Injector.exe` | `Z:/home/user/.daybreak/Injector/Daybreak.Injector.exe` |
```csharp
// PathUtils.cs
public static string ToWinePath(string linuxPath)
{
// Convert /path/to/file to Z:/path/to/file
return $"Z:{linuxPath.Replace('/', '\\')}";
}
```
### Wine Debug Log
Debug builds append all Wine output to `wine-debug.log` in the Daybreak output
folder:
```text
Daybreak.Linux/bin/Debug/net10.0/linux-x64/wine-debug.log
```
This is the place to look when Guild Wars dies without an error. Guild Wars is a
grandchild of the Wine process Daybreak starts, so its stderr would otherwise go
to a pipe nobody reads and the crash report would be lost. Wine runs
`winedbg --auto` on a crash, so the log contains the faulting stack — including
managed frames when `Daybreak.API` is at fault:
```text
err:eventlog:ReportEventW L"Message: Access Violation: Attempted to read or write protected memory..."
err:eventlog:ReportEventW L" at Daybreak.API.Interop.GuildWars.GuildWarsArray`1.Enumerator.get_Current()"
err:eventlog:ReportEventW L" at Daybreak.API.Services.CharacterSelectService...
err:seh:NtRaiseException Unhandled exception code c0000409
```
Note that `Daybreak.API` is NativeAOT, which cannot throw
`AccessViolationException`. A bad pointer read therefore calls `FailFast` and
terminates Guild Wars instantly, with nothing written to `Daybreak.API.log`.
Each launch is delimited by a `===== <timestamp> <command> =====` header. The
log is append-only, so delete it when it gets large.
Environment variables:
| Variable | Effect |
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `DAYBREAK_WINE_DEBUG` | `1` forces logging on, `0` off. Defaults to on for Debug builds, off for Release. |
| `DAYBREAK_WINE_DEBUG_CHANNELS` | Sets `WINEDEBUG`, e.g. `+seh`. Unset by default — Wine's default `err` class already reports crashes, and trace channels slow the game badly. |
______________________________________________________________________
## Credits
- Daybreak project is distributed under [MIT license](https://mit-license.org/)
- Tango icons - [LordBiro](https://wiki.guildwars.com/wiki/User:LordBiro)
- Icons `Daybreak/wwwroot/img/tango` are distributed under
[GFDL license](https://en.wikipedia.org/wiki/GNU_Free_Documentation_License)
[screenshot]: https://github.com/user-attachments/assets/3eb74d22-a3ac-4463-8d26-8142cea3d237
Reference in New Issue View Git Blame Copy Permalink