sdl3-bindgen-sys 0.0.0.1 → 0.0.0.2
raw patch · 3 files changed
+80/−10 lines, 3 filesPVP ok
version bump matches the API change (PVP)
API changes (from Hackage documentation)
Files
- CHANGELOG.md +12/−0
- README.md +66/−8
- sdl3-bindgen-sys.cabal +2/−2
CHANGELOG.md view
@@ -1,5 +1,17 @@ # Changelog — sdl3-bindgen-sys +## 0.0.0.2 - 2026-07-26++Documentation-only patch.++### Changed++- README: per-platform install list in Quick start and a+ `Windows set up` section.++Thanks to @oddron in the Haskell GameDev Discord for giving the library+a try on Windows!+ ## 0.0.0.1 - 2026-07-26 Initial release.
README.md view
@@ -29,18 +29,28 @@ ## Quick start +### Install build requirements+ Install SDL **>= 3.2** development files where `pkg-config` can find-them: `apt install libsdl3-dev` (Debian/Ubuntu), `brew install sdl3`-(macOS), `pacman -S sdl3` (Arch), MSYS2's `mingw-w64-ucrt-x86_64-sdl3`-(Windows), or-[build from source](https://wiki.libsdl.org/SDL3/Installation) on-distros that don't package SDL3 yet.+them. The development headers must be present, not just the shared+library. -The development _headers_ must be present, not just the shared library.+Common setups: -Add `sdl3-bindgen-sys` to `build-depends`, and:+- **Debian/Ubuntu**: `apt install libsdl3-dev`+- **macOS**: `brew install sdl3`+- **Arch**: `pacman -S sdl3`+- **Fedora**: `dnf install SDL3-devel`+- **Windows**: WSL2 with the Linux instructions, or native MSYS2.+ See [Windows set up](#windows-set-up) +### Set up your project++1. Add `sdl3-bindgen-sys` to `build-depends`+2. Replace the contents of `Main.hs` with:+ ```haskell+{-# LANGUAGE GHC2021 #-} {-# LANGUAGE BlockArguments #-} import Control.Monad (unless)@@ -61,13 +71,61 @@ SDL3.quit ``` -For something real, see+For more examples and templates, see [`lithon-examples`](https://github.com/jtnuttall/lithon/tree/main/lithon-examples) in the repository: - `sdl3-raw` is a minimal triangle with an event loop - `shmup` is a playable `apecs` game running on and rendering through these bindings++### Windows set up++There are two ways to set this up that I am aware of. In order of+convenience:++#### WSL2++The Linux instructions apply unchanged. Under WSLg an SDL window+displays like any Linux app.++#### Native (MSYS2)++Install build dependencies:++```sh+pacman -Syyu # repeat/restart terminal if pacman asks you to+pacman -S mingw-w64-ucrt-x86_64-sdl3 mingw-w64-ucrt-x86_64-pkgconf+```++> [!NOTE]+> The UCRT64 pkgconf is required. MSYS2 `pkg-config` reports POSIX-style+> paths that GHC can't use on Windows.++##### Stack users++> [!IMPORTANT]+> Stack users need some additional setup.+>+> Adjust the library version in `extra-deps` to your desired target.++1. Run the `pacman` commands above through `stack exec -- pacman ...` so+ that the packages are installed in `stack`'s MSYS2.+2. Add `msys-environment: UCRT64` to your `stack.yaml`.+3. Add `sdl3-bindgen-sys-0.0.0.2` to `extra-deps` in your `stack.yaml`. Running+ `stack build` should print out a helpful, pasteable entry for+ this purpose.++Your `stack.yaml` should look something like this:++```yaml+snapshot: lts-24.51+packages:+ - .+extra-deps:+ - sdl3-bindgen-sys-0.0.0.2 # hash may be here if you copy from stack build+msys-environment: UCRT64 # important: build will not work without this+``` ## Library structure
sdl3-bindgen-sys.cabal view
@@ -4,10 +4,10 @@ -- -- see: https://github.com/sol/hpack ----- hash: "v\192\194\247\225\129e\DEL\238^\168q\247\215\247M}\241\168\184~\192\216\DC1OG0W\EM/@\233"+-- hash: "\r\234\246\191\143\ETBu\ENQ\229\144\219\242\163T\191\196\254s~\247\ETBP\219OP\206w\141/\136\132\248" name: sdl3-bindgen-sys-version: 0.0.0.1+version: 0.0.0.2 synopsis: Complete SDL3 bindings, raw + curated, generated by hs-bindgen description: Machine-generated low-level bindings to the whole SDL 3.4 API: the raw hs-bindgen output (@SDL3.Sys.Bindgen.*@) plus a curated @SDL3.Sys@ layer