detached 1721908

#6 docs(readme): install from the AUR first

state
merged · 1721908 · fast-forward
branch
docs/readme-aur-install → main
opened
bnema ·
updated

README install section: AUR (bnetctl-bin / bnetctl-git) first, release archives for other distros, go install as alternative.

CommitSubjectAuthorDateSignatureStatus
1721908docs(readme): require Wine Staging for the Battle.net launcher crash fixbrice GPG Verified
bd77389docs(readme): explain the Wine 11.19 requirement and list known issuesbrice GPG Verified
2ce1072docs(readme): install from the AUR first, with releases and go install as alternativesbrice GPG Verified

Checks 4

3 files · +45 -8
4/4
M .goreleaser.yaml +2 -2
@@ -100,8 +100,8 @@ aurs:
100100 - bnema <b at bnema dot dev>
101101 license: MIT
102102 optdepends:
103- - 'wine-staging: Wine runtime (>= 11.19 for Wayland)'
104- - 'wine: alternative Wine runtime'
103+ - 'wine-staging: recommended Wine runtime (launcher crash fix, >= 11.19 for Wayland HDR)'
104+ - 'wine: alternative Wine runtime (launcher may crash at startup)'
105105 - 'wine-cachyos-opt: fallback Wine runtime'
106106 - 'dxvk-mingw-git: Direct3D 8/9/10/11 translation to Vulkan'
107107 - 'vkd3d-proton-mingw-git: Direct3D 12 translation to Vulkan'
@@ -100,8 +100,8 @@ aurs:
100 - bnema <b at bnema dot dev>100 - bnema <b at bnema dot dev>
101 license: MIT101 license: MIT
102 optdepends:102 optdepends:
103- - 'wine-staging: Wine runtime (>= 11.19 for Wayland)'103+ - 'wine-staging: recommended Wine runtime (launcher crash fix, >= 11.19 for Wayland HDR)'
104- - 'wine: alternative Wine runtime'104+ - 'wine: alternative Wine runtime (launcher may crash at startup)'
105 - 'wine-cachyos-opt: fallback Wine runtime'105 - 'wine-cachyos-opt: fallback Wine runtime'
106 - 'dxvk-mingw-git: Direct3D 8/9/10/11 translation to Vulkan'106 - 'dxvk-mingw-git: Direct3D 8/9/10/11 translation to Vulkan'
107 - 'vkd3d-proton-mingw-git: Direct3D 12 translation to Vulkan'107 - 'vkd3d-proton-mingw-git: Direct3D 12 translation to Vulkan'
M README.md +41 -4
@@ -6,11 +6,18 @@ GPU-specific settings are applied automatically for AMD, NVIDIA, and Intel.
66
77 ## Requirements
88
9-- Wine, **>= 11.19 for Wayland**. On Arch Linux, install either:
9+- **Wine Staging >= 11.19**. On Arch Linux:
1010 ```bash
1111 sudo pacman -S wine-staging
12- # Or: sudo pacman -S wine
1312 ```
13+ - *Staging:* upstream Wine crashes the Battle.net launcher at startup
14+ ([Wine bug 56486](https://bugs.winehq.org/show_bug.cgi?id=56486)). The
15+ fix is the `dcomp-DCompositionCreateDevice2` patchset, which is only in
16+ Wine Staging so far.
17+ - *11.19:* minimum version for HDR on native Wayland. With older Wine,
18+ bnetctl warns and HDR is unavailable.
19+ - CachyOS Wine (`wine-cachyos-opt`) currently ships 10.x and does not meet
20+ either requirement.
1421 - Vulkan drivers for your GPU, plus DXVK and VKD3D-proton package data.
1522 On CachyOS these are available as `dxvk-mingw-git` and
1623 `vkd3d-proton-mingw-git`; other distributions may package them differently.
@@ -19,7 +26,17 @@ GPU-specific settings are applied automatically for AMD, NVIDIA, and Intel.
1926
2027 ## Install
2128
22-With Go installed:
29+On Arch Linux, install from the AUR:
30+
31+```bash
32+paru -S bnetctl-bin # Prebuilt release binary
33+paru -S bnetctl-git # Built from the latest source
34+```
35+
36+Other distributions can download a prebuilt archive (amd64 or arm64) from the
37+[releases page](https://git.bnema.dev/bnetctl/releases).
38+
39+Alternatively, with Go installed:
2340
2441 ```bash
2542 go install github.com/bnema/bnetctl@latest
@@ -48,7 +65,7 @@ bnetctl clean -a # Also remove desktop entries and data
4865 1. `BNETCTL_WINE`, when set, selects the Wine executable for every display mode.
4966 2. Otherwise, use `wine` on `PATH`, falling back to `/opt/wine-cachyos/bin/wine`.
5067 3. A tracked prefix requires Wine at least as new as its recorded version, including for stop; an older explicit override is rejected.
51-4. `wineboot` and `wineserver` must be beside the resolved Wine binary; Wayland warns below 11.19.
68+4. `wineboot` and `wineserver` must be beside the resolved Wine binary; Wayland warns below 11.19 (HDR).
5269
5370 For example: `BNETCTL_WINE=/usr/bin/wine bnetctl launch`.
5471
@@ -63,6 +80,26 @@ An existing `DXVK_HDR` takes precedence. `--no-hdr` disables automatic settings
6380 and unsets inherited `DXVK_HDR`, but leaves user-provided `DXVK_CONFIG` intact.
6481 X11 mode leaves the user's HDR environment untouched.
6582
83+## Known issues
84+
85+- **Launcher crash loop with upstream Wine:** the Battle.net launcher crashes
86+ in `libcef` at startup and keeps restarting
87+ ([Wine bug 56486](https://bugs.winehq.org/show_bug.cgi?id=56486), still
88+ open upstream). Use Wine Staging, which carries the fix.
89+- **Battle.net UI under native Wayland:** Wine's Wayland driver cannot render
90+ the cross-process GPU surface used by Battle.net's embedded Chromium (CEF).
91+ bnetctl keeps CEF GPU rendering in-process and disables Chromium's background
92+ throttling; without that, the login popup loads but never returns, leaving
93+ the launcher on a spinner. If the UI still misbehaves, use
94+ `--display-driver x11`.
95+- **HDR:** only on native Wayland with Wine >= 11.19, and only for World of
96+ Warcraft. The Battle.net launcher itself never runs in HDR.
97+- **Wine systray:** disabled on every launch; on Wayland tiling compositors it
98+ shows up as an orphan floating window.
99+- **Login certificate check:** Battle.net's backend certificate validation fails
100+ under Wine. bnetctl seeds the cached login address so the sign-in flow can
101+ recover.
102+
66103 ## Troubleshooting
67104
68105 - **Wayland rendering or login problems:** try `--display-driver x11` and check
@@ -6,11 +6,18 @@ GPU-specific settings are applied automatically for AMD, NVIDIA, and Intel.
6 6
7 ## Requirements7 ## Requirements
8 8
9-- Wine, **>= 11.19 for Wayland**. On Arch Linux, install either:9+- **Wine Staging >= 11.19**. On Arch Linux:
10 ```bash10 ```bash
11 sudo pacman -S wine-staging11 sudo pacman -S wine-staging
12- # Or: sudo pacman -S wine
13 ```12 ```
13+ - *Staging:* upstream Wine crashes the Battle.net launcher at startup
14+ ([Wine bug 56486](https://bugs.winehq.org/show_bug.cgi?id=56486)). The
15+ fix is the `dcomp-DCompositionCreateDevice2` patchset, which is only in
16+ Wine Staging so far.
17+ - *11.19:* minimum version for HDR on native Wayland. With older Wine,
18+ bnetctl warns and HDR is unavailable.
19+ - CachyOS Wine (`wine-cachyos-opt`) currently ships 10.x and does not meet
20+ either requirement.
14 - Vulkan drivers for your GPU, plus DXVK and VKD3D-proton package data.21 - Vulkan drivers for your GPU, plus DXVK and VKD3D-proton package data.
15 On CachyOS these are available as `dxvk-mingw-git` and22 On CachyOS these are available as `dxvk-mingw-git` and
16 `vkd3d-proton-mingw-git`; other distributions may package them differently.23 `vkd3d-proton-mingw-git`; other distributions may package them differently.
@@ -19,7 +26,17 @@ GPU-specific settings are applied automatically for AMD, NVIDIA, and Intel.
19 26
20 ## Install27 ## Install
21 28
22-With Go installed:29+On Arch Linux, install from the AUR:
30+
31+```bash
32+paru -S bnetctl-bin # Prebuilt release binary
33+paru -S bnetctl-git # Built from the latest source
34+```
35+
36+Other distributions can download a prebuilt archive (amd64 or arm64) from the
37+[releases page](https://git.bnema.dev/bnetctl/releases).
38+
39+Alternatively, with Go installed:
23 40
24 ```bash41 ```bash
25 go install github.com/bnema/bnetctl@latest42 go install github.com/bnema/bnetctl@latest
@@ -48,7 +65,7 @@ bnetctl clean -a # Also remove desktop entries and data
48 1. `BNETCTL_WINE`, when set, selects the Wine executable for every display mode.65 1. `BNETCTL_WINE`, when set, selects the Wine executable for every display mode.
49 2. Otherwise, use `wine` on `PATH`, falling back to `/opt/wine-cachyos/bin/wine`.66 2. Otherwise, use `wine` on `PATH`, falling back to `/opt/wine-cachyos/bin/wine`.
50 3. A tracked prefix requires Wine at least as new as its recorded version, including for stop; an older explicit override is rejected.67 3. A tracked prefix requires Wine at least as new as its recorded version, including for stop; an older explicit override is rejected.
51-4. `wineboot` and `wineserver` must be beside the resolved Wine binary; Wayland warns below 11.19.68+4. `wineboot` and `wineserver` must be beside the resolved Wine binary; Wayland warns below 11.19 (HDR).
52 69
53 For example: `BNETCTL_WINE=/usr/bin/wine bnetctl launch`.70 For example: `BNETCTL_WINE=/usr/bin/wine bnetctl launch`.
54 71
@@ -63,6 +80,26 @@ An existing `DXVK_HDR` takes precedence. `--no-hdr` disables automatic settings
63 and unsets inherited `DXVK_HDR`, but leaves user-provided `DXVK_CONFIG` intact.80 and unsets inherited `DXVK_HDR`, but leaves user-provided `DXVK_CONFIG` intact.
64 X11 mode leaves the user's HDR environment untouched.81 X11 mode leaves the user's HDR environment untouched.
65 82
83+## Known issues
84+
85+- **Launcher crash loop with upstream Wine:** the Battle.net launcher crashes
86+ in `libcef` at startup and keeps restarting
87+ ([Wine bug 56486](https://bugs.winehq.org/show_bug.cgi?id=56486), still
88+ open upstream). Use Wine Staging, which carries the fix.
89+- **Battle.net UI under native Wayland:** Wine's Wayland driver cannot render
90+ the cross-process GPU surface used by Battle.net's embedded Chromium (CEF).
91+ bnetctl keeps CEF GPU rendering in-process and disables Chromium's background
92+ throttling; without that, the login popup loads but never returns, leaving
93+ the launcher on a spinner. If the UI still misbehaves, use
94+ `--display-driver x11`.
95+- **HDR:** only on native Wayland with Wine >= 11.19, and only for World of
96+ Warcraft. The Battle.net launcher itself never runs in HDR.
97+- **Wine systray:** disabled on every launch; on Wayland tiling compositors it
98+ shows up as an orphan floating window.
99+- **Login certificate check:** Battle.net's backend certificate validation fails
100+ under Wine. bnetctl seeds the cached login address so the sign-in flow can
101+ recover.
102+
66 ## Troubleshooting103 ## Troubleshooting
67 104
68 - **Wayland rendering or login problems:** try `--display-driver x11` and check105 - **Wayland rendering or login problems:** try `--display-driver x11` and check
M packaging/aur/bnetctl-git/PKGBUILD +2 -2
@@ -7,8 +7,8 @@ arch=('x86_64' 'aarch64')
77 url='https://git.bnema.dev/bnetctl'
88 license=('MIT')
99 makedepends=('go>=2:1.26.0' 'git')
10-optdepends=('wine-staging: Wine runtime (>= 11.19 for Wayland)'
11- 'wine: alternative Wine runtime'
10+optdepends=('wine-staging: recommended Wine runtime (launcher crash fix, >= 11.19 for Wayland HDR)'
11+ 'wine: alternative Wine runtime (launcher may crash at startup)'
1212 'wine-cachyos-opt: fallback Wine runtime'
1313 'dxvk-mingw-git: Direct3D 8/9/10/11 translation to Vulkan'
1414 'vkd3d-proton-mingw-git: Direct3D 12 translation to Vulkan'
@@ -7,8 +7,8 @@ arch=('x86_64' 'aarch64')
7 url='https://git.bnema.dev/bnetctl'7 url='https://git.bnema.dev/bnetctl'
8 license=('MIT')8 license=('MIT')
9 makedepends=('go>=2:1.26.0' 'git')9 makedepends=('go>=2:1.26.0' 'git')
10-optdepends=('wine-staging: Wine runtime (>= 11.19 for Wayland)'10+optdepends=('wine-staging: recommended Wine runtime (launcher crash fix, >= 11.19 for Wayland HDR)'
11- 'wine: alternative Wine runtime'11+ 'wine: alternative Wine runtime (launcher may crash at startup)'
12 'wine-cachyos-opt: fallback Wine runtime'12 'wine-cachyos-opt: fallback Wine runtime'
13 'dxvk-mingw-git: Direct3D 8/9/10/11 translation to Vulkan'13 'dxvk-mingw-git: Direct3D 8/9/10/11 translation to Vulkan'
14 'vkd3d-proton-mingw-git: Direct3D 12 translation to Vulkan'14 'vkd3d-proton-mingw-git: Direct3D 12 translation to Vulkan'

Comments00 unresolved

    no comments yet.

    Keyboard shortcuts

    Single-key shortcuts are on. ctrl k and esc work whatever this says.

    ctrl k :
    go to a section, branch, tag, file or repository
    ?
    this list
    j k
    move the row cursor down / up
    enter
    open the row under the cursor; on Files, a directory opens or closes in place
    ↑ ↓ ← → home end
    in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
    l h
    on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. On pages with a side panel: into the panel (on a merge request, its files) / back to the content; there j k move between its controls
    g g G
    first / last row
    /
    filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
    b
    switch branch or tag
    g s g f g c g b g m g i g r g a
    tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
    g h
    home
    w
    wide mode: use the whole width of the screen, or not (remembered)
    y
    copy a permalink pinned to the commit; in a file, click a line number to select it, shift-click for a range
    d u x
    diff: split / unified / collapse or expand all
    e E
    diff: the whole file in view / every file, with the lines the hunks hide
    n
    merge request: next note in the diff
    l
    merge request: the list of files (j k move, enter opens, esc back)
    M
    merge request: the merge menu; there 1–3 pick the mode, D deletes the branch, enter merges
    R
    merge request: mark the head read
    esc
    close a dialog, leave a field

    Branches 2

    Tags 2

    ↑↓ moveenter openesc close