kegtui 1.0.0

Run Windows games/apps on macOS through wine
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

# kegtui

> [!WARNING]
> kegtui does **NOT** create wrappers or engines or claim legal rights to them. kegtui is **NOT** a substitute for using [Kegworks][kegworks] to obtain wrappers or engines. However, kegtui can assemble wrappers and engines into a keg.

Terminal interface for [Kegworks][kegworks].

## Download

[![macOS Download](https://img.shields.io/badge/macOS-Download-green?logo=apple&logoColor=white)](https://github.com/ethanuppal/kegtui/releases)

### First-time setup

After clicking on this button and downloading the latest release, you should now have a `.dmg` downloaded:

![DMG with kegtui.app and the Applications folder](./images/dmg.png)

Now, drag the `kegtui.app` into your applications folder.

Next, open your Terminal app. Please see the [instructions provided by Apple](https://support.apple.com/en-ng/guide/terminal/apd5265185d-f365-44cb-8b09-71a064a42125/mac) if you do not know how to do this.

Inside Terminal, type the following command and press enter.
```bash
xattr -d com.apple.quarantine /Applications/kegtui.app
```
After this step, you can close Terminal.

Now, open the app from your applications folder or by typing its name into Spotlight.
The app should look like this:

![The app start screen](./images/first-time-open.png)

## Usage

Press `?` anywhere to view keybinds.

### Setup

Once you've opened the app, here's how to setup Steam:

1. Run the setup wizard.
2. Create a new keg using the wrapper and engine downloaded from the setup wizard. If you don't see them, quit and reopen the app.
3. Now, go to the kegs section. If you don't see your new keg, quit and reopen the app.
4. Install the Windows version of Steam: <https://store.steampowered.com/about/download>.
    Choose `Open C Drive` and then drag `SteamSetup.exe` into `Program Files (x86)/`.
    You can do this via kegtui by choosing `Edit Config` and set the program path to `"/Program Files (x86)/SteamSetup.exe"`.
    Then, `Launch` the keg.

    If that does not work, choose `Winetricks` and then uncomment the line starting with `# steam.app = `.
    Then, save and quit the file.
    The winetricks file will be opened by default in your `$EDITOR`; if you didn't define this, it'll open in plain Vim.
    You may have a glitch where you cannot see the cursor.
5. Verify that Steam is installed by choosing `Open C Drive` and navigating to the steam installation folder in `Program Files (x86)`.
5. Once Steam is installed, choose `Edit Config` and set the program path to `"/Program Files (x86)/Steam/Steam.exe"`. You should also enable a graphics translation like DXMT. Only enable ONE graphics translation. For example:
    ```toml
    [translation]
    d3d_metal = false
    dxvk = false
    dxmt = true
    molten_vkcx = true
    fast_math = false
    advertise_avx = true
    metal_hud = true
    ```
6. Finally, you should be able to `Launch` the keg and use Steam as normal.

Remember to exit Steam by selecting `Kill Processes` in kegtui when you're done --- this is the equivalent of doing `Cmd-Shift-K` in Whisky.

> [!NOTE]
> If you use a different shell than the native shell, you'll have to configure it in the environment.
> See the "Config" section for more information.

## Config

### Each Keg

The menu for each keg has an `Edit Config` option.
Use this to, for instance, enable DXMT for games.

### Core App

See [the definition of the config file](./core/src/app_config.rs).
It is located at `$XDG_CONFIG_HOME/kegtui.toml`.

### Wrapper

There is experimental configuration using the Debug Config menu at the bottom of the app.
These are the options for the environment:

- `KEGTUI_HIDE_EXTRA_UI=1` hides this debug UI (you can still make config changes from the Application Support folder)
- `KEGTUI_FONT_SIZE` changes the font size
- `KEGTUI_EXIT_ON_TERMINAL_SHUTDOWN=0` does not quit the app if the terminal shuts down
- `SHELL` overrides `zsh` as the shell environment used

The font config file is just the name of a font you have installed on your computer.

## Support [GCenx](https://github.com/Gcenx) / [Kegworks][kegworks].

Wine on macOS is effecivtively made possible by him.
Please support him in any way possible!

- https://paypal.me/gcenx
- https://ko-fi.com/gcenx

[kegworks]: https://github.com/Sikarugir-App/Sikarugir