Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,24 +27,24 @@ body:
id: logs
attributes:
label: Logs
description: Please provide the logs from the launched Wine process. These can be found by pressing `CMD + L` in Whisky.
description: Please provide the logs from the launched Wine process. These can be found by pressing `CMD + L` in Brandy.
render: bash
validations:
required: true
- type: dropdown
id: whisky-version
- type: input
id: brandy-version
attributes:
label: What version of Whisky are you using?
options:
- "2.3.2"
- "<2.3.2"
label: What version of Brandy are you using?
description: Shown in Brandy > About Brandy.
validations:
required: true
- type: dropdown
id: mac-version
attributes:
label: What version of macOS are you using?
options:
- "Tahoe (macOS 26)"
- "Sequoia (macOS 15)"
- "Sonoma (macOS 14)"
validations:
required: true
Expand Down
3 changes: 0 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
blank_issues_enabled: false
- name: Discord Support
url: https://discord.gg/K4AQukwAke
about: Please ask for support first to confirm the issue before submitting a report.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# How to contribute

Thanks for your interest! First, make a fork of Whisky, make a new branch for your changes, and get coding!
Thanks for your interest! First, make a fork of Brandy, make a new branch for your changes, and get coding!

# Build environment

Whisky is built using Xcode 15 on macOS Sonoma. All external dependencies are handled through the Swift Package Manager.
Brandy is built using Xcode 26 on macOS Sequoia or later. All external dependencies are handled through the Swift Package Manager.

# Code style

Every Whisky commit is automatically linted using SwiftLint. You can run these checks locally simply by building in Xcode, violations will appear as errors or warnings. For your pull request to be merged, you must meet all the requirements outlined by SwiftLint and have no violations.
Every Brandy commit is automatically linted using SwiftLint. You can run these checks locally simply by building in Xcode, violations will appear as errors or warnings. For your pull request to be merged, you must meet all the requirements outlined by SwiftLint and have no violations.

Generally, it is not advised to disable a SwiftLint rule, but there are certain situations where it is necessary. Please use your discretion when disabling rules temporarily.

SwiftLint does not fully check indentation, but we ask that you indent with 4-width spaces. This can be automatically configured in Xcode's settings.

All added strings must be properly localised and added to the EN strings file. Do not add keys for other languages or translate within your PR. All translations should be handled on [Crowdin](https://crowdin.com/project/whisky).
All added strings must be properly localised and added to the English strings in `Whisky/Localizable.xcstrings`. Do not add keys for other languages or translate within your PR.

# Making your PR

Expand Down
75 changes: 21 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,81 +1,48 @@
<div align="center">

# Whisky 🥃
*Wine but a bit stronger*

![](https://img.shields.io/github/actions/workflow/status/iStorry/Whisky/CI.yml?branch=main&style=for-the-badge)
[![](https://img.shields.io/discord/1115955071549702235?style=for-the-badge)](https://discord.gg/CsqAfs9CnM)
</div>

## Maintenance Notice

[Whisky is no longer actively maintained](https://docs.getwhisky.app/maintenance-notice). Apps and games may break at any time.
<img src="./images/brandy-icon.png" width="160" alt="Brandy icon">

<img width="650" alt="Config" src="https://github.com/Whisky-App/Whisky/assets/42140194/d0a405e8-76ee-48f0-92b5-165d184a576b">
# Brandy

Familiar UI that integrates seamlessly with macOS
*Windows games on your Mac, set up in a few clicks*

<div align="right">
<img width="650" alt="New Bottle" src="https://github.com/Whisky-App/Whisky/assets/42140194/ed1a0d69-d8fb-442b-9330-6816ba8981ba">

One-click bottle creation and management
![](https://img.shields.io/github/actions/workflow/status/iStorry/Whisky/CI.yml?branch=main&style=for-the-badge)
</div>

<img width="650" alt="debug" src="https://user-images.githubusercontent.com/42140194/229176642-57b80801-d29b-4123-b1c2-f3b31408ffc6.png">

Debug and profile with ease

---

Whisky provides a clean and easy to use graphical wrapper for Wine built in native SwiftUI. You can make and manage bottles, install and run Windows apps and games, and unlock the full potential of your Mac with no technical knowledge required. Whisky is built on top of CrossOver 22.1.1, and Apple's own `Game Porting Toolkit`.
Brandy is a native SwiftUI app for running Windows games and apps on your Mac, made for people who don't want to learn how Wine works. Open it, click **Set Up Steam**, and Brandy prepares your Mac, downloads its Windows layer, creates a place for your games, and installs Steam from Valve. After that, it's one button: **Open Steam**.

Translated on [Crowdin](https://crowdin.com/project/whisky).
Everything that used to be required is still there for those who want it. Turn on **Show advanced options** in Settings to manage bottles, installed programs, Windows versions, DXVK, Winetricks and Wine's own tools.

---
Brandy is a fork of [Whisky](https://github.com/Whisky-App/Whisky), which is no longer maintained. Brandy is distilled from wine, just as this app is distilled from Whisky.

## System Requirements

- CPU: Apple Silicon (M-series chips)
- OS: macOS Sonoma 14.0 or later
- About 3 GB of free space for the Windows layer and Steam

## Homebrew

Whisky is on homebrew! Install with
`brew install --cask whisky`.

## My game isn't working!
## What's Inside

Some games need special steps to get working. Check out the [wiki](https://github.com/IsaacMarovitz/Whisky/wiki/Game-Support).
- **Wine 11.0**, the official WineHQ macOS build by Gcenx
- **DXVK-macOS** for Direct3D 10 and 11 through Vulkan, off by default
- **Windows 10 or 11** for each bottle

---
The Windows layer is published as the `whiskywine-3` release of this repository. `scripts/build-whiskywine.sh` rebuilds it from pinned, checksum-verified upstream releases.

## Credits & Acknowledgments

Whisky is possible thanks to the magic of several projects:
Brandy exists thanks to:

- [msync](https://github.com/marzent/wine-msync) by marzent
- [DXVK-macOS](https://github.com/Gcenx/DXVK-macOS) by Gcenx and doitsujin
- [Whisky](https://github.com/Whisky-App/Whisky) by Isaac Marovitz and contributors, which Brandy is built on
- [Wine](https://www.winehq.org) by the Wine project and CodeWeavers
- [macOS Wine builds](https://github.com/Gcenx/macOS_Wine_builds) and [DXVK-macOS](https://github.com/Gcenx/DXVK-macOS) by Gcenx and doitsujin
- [MoltenVK](https://github.com/KhronosGroup/MoltenVK) by KhronosGroup
- [Winetricks](https://github.com/Winetricks/winetricks)
- [Sparkle](https://github.com/sparkle-project/Sparkle) by sparkle-project
- [SemanticVersion](https://github.com/SwiftPackageIndex/SemanticVersion) by SwiftPackageIndex
- [swift-argument-parser](https://github.com/apple/swift-argument-parser) by Apple
- [SwiftTextTable](https://github.com/scottrhoyt/SwiftyTextTable) by scottrhoyt
- [CrossOver 22.1.1](https://www.codeweavers.com/crossover) by CodeWeavers and WineHQ
- D3DMetal by Apple

Special thanks to Gcenx, ohaiibuzzle, and Nat Brown for their support and contributions!

---
- [SwiftyTextTable](https://github.com/scottrhoyt/SwiftyTextTable) by scottrhoyt

<table>
<tr>
<td>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./images/cw-dark.png">
<img src="./images/cw-light.png" width="500">
</picture>
</td>
<td>
Whisky doesn't exist without CrossOver. Support the work of CodeWeavers using our <a href="https://www.codeweavers.com/store?ad=1010">affiliate link</a>.
</td>
</tr>
</table>
Brandy is free software under the [GNU General Public License v3](LICENSE).
Loading
Loading