Skip to content

Run Windows games on Apple Silicon — free, open source, with an open compatibility database that tells you what actually works.

pre-announcement: app screenshot in README, bug template, CONTRIBUTING, issue-form routing

Gauthier Piarrette0826c417fa53
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
new file mode 100644
index 0000000..865198a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug.yml
@@ -0,0 +1,19 @@
+name: Bug report
+description: Something in Highball itself broke (for game results, use the report form on highball-db)
+labels: [bug]
+body:
+ - type: input
+ id: what
+ attributes: { label: What happened }
+ validations: { required: true }
+ - type: input
+ id: chip
+ attributes: { label: Chip and macOS, placeholder: "M1 Pro, macOS 14.6" }
+ validations: { required: true }
+ - type: input
+ id: version
+ attributes: { label: Highball version, placeholder: "0.3.1" }
+ validations: { required: true }
+ - type: textarea
+ id: log
+ attributes: { label: Log, description: "Attach the newest file from ~/Library/Application Support/Highball/logs/" }
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..55c0027
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+ - name: Game or launcher compatibility report
+ url: https://github.com/gauthierpiarrette/highball-db/issues/new/choose
+ about: "How did a game run? That data belongs in the open database."
diff --git a/.github/assets/app.png b/.github/assets/app.png
new file mode 100644
index 0000000..1156e8c
Binary files /dev/null and b/.github/assets/app.png differ
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..d4791a3
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,15 @@
+# Contributing
+
+**Ran a game?** That's the most valuable contribution: `highball report <bottle> "<title>" --rating N`
+opens a pre-filled issue on [highball-db](https://github.com/gauthierpiarrette/highball-db). Chip, macOS,
+engine and renderer are captured automatically.
+
+**Recipes** (install/config knowledge) are CC0 data in highball-db — PR with the CLI output attached.
+Every recipe carries `lastVerified` so stale data is visible rather than silently wrong.
+
+**Code**: `swift build && swift test` is the whole loop; `Scripts/make-app.sh debug` builds the app
+bundle. Match the style around you. By contributing you license your work under GPL-3.0 (code) or
+CC0 (data).
+
+**Engines**: manifest PRs bumping pinned SHA-256s, with a note on what you verified. Highball never
+hosts binaries and never carries Wine patches — that's a design rule, not a preference.
diff --git a/README.md b/README.md
index 94c57a9..ebfae9b 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
<h1 align="center">Highball</h1>
<p align="center"><b>Run Windows games on Apple Silicon. Free, open, engine-agnostic.</b></p>
+<p align="center"><img src=".github/assets/app.png" width="760" alt="Highball showing a bottle with a verified game, renderer verdict from the open database, and one-click launcher installs"></p>
+
Highball is the successor to the idea behind [Whisky](https://github.com/Whisky-App/Whisky):
a native macOS app (and CLI) that sets up Wine, DXMT, D3DMetal and DXVK for you, installs
Steam and other launchers with one click, and tells you honestly what runs, what doesn't,