https://github.com/nim-lang/sdl2

Nim wrapper for SDL 2.x
https://github.com/nim-lang/sdl2

Last synced: about 2 months ago
JSON representation

Nim wrapper for SDL 2.x

• Host: GitHub
• URL: https://github.com/nim-lang/sdl2
• Owner: nim-lang
• License: mit
• Created: 2014-03-01T22:01:13.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-01-01T14:47:23.000Z (9 months ago)
• Last Synced: 2024-05-18T15:42:27.236Z (4 months ago)
• Language: Nim
• Homepage:
• Size: 764 KB
• Stars: 228
• Watchers: 21
• Forks: 71
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-electron-alternatives - SDL2
• awesome-nim - SDL2 - Official wrapper for SDL 2.x. (User Interface / GUI)

README

        
# SDL2 for Nim

This package contains the bindings for SDL2 to Nim.

# Pre-requisites

You must install the SDL2 C libraries before these Nim bindings can be used.

## macOS 

#### Homebrew

If you don't already have Homebrew installed, install it from [the Homebrew site](https://brew.sh/).

Install the SDL2 C libraries:

```bash

brew install sdl2{,_gfx,_image,_mixer,_net,_ttf}

```

#### MacPorts

If you don't already have Macports installed, install it from [the Macports site](https://www.macports.org).

```bash

sudo port install libsdl2 libsdl2_gfx libsdl2_image libsdl2_mixer libsdl2_ttf libsdl2_net

```

## Linux

Install SDL2 development libraries using your distribution's packaging tool of choice.

## Windows

Using SDL2 with [mingw-w64](https://mingw-w64.org) environment

 * Install [mingw-w64-builds](https://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win32/Personal%20Builds/mingw-builds/installer/mingw-w64-install.exe). Check that `x86_64-w64-mingw32\bin\` from the installed mingw toolchain is in your `PATH` variable.

 * Download [SDL2 Development Libraries](https://www.libsdl.org/download-2.0.php) for MinGW

 * Extract contents of the downloaded archive to your mingw-w64 folder (for example, `SDL2-2.0.12\x86_64-w64-mingw32\` to `mingw-w64\x86_64-8.1.0-posix-seh-rt_v6-rev0\mingw64\x86_64-w64-mingw32\`)

 ### Static linking SDL2

 Pass the following options to nim on compilation:

 `--dynlibOverride:libSDL2 --passL:"-static -lmingw32 -lSDL2main -lSDL2 -mwindows  -Wl,--no-undefined -Wl,--dynamicbase -Wl,--nxcompat -Wl,--high-entropy-va -lm -ldinput8 -ldxguid -ldxerr8 -luser32 -lgdi32 -lwinmm -limm32 -lole32 -loleaut32 -lshell32 -lsetupapi -lversion -luuid"`

 Options for the linker (`--passL:`) except `-static` are taken from `sdl2-config.cmake` which is included in SDL2 Development Libraries.

# Installation

Add `requires "sdl2"` to your `.nimble` file.

You can also install manually with `nimble install sdl2` if your project does not yet have a nimble package file.

For more information on using nimble, consult [the nim documentation](https://nim-lang.org/docs/lib.html#nimble).

# Documentation

For documentation about SDL2 see [wiki.libsdl.org](https://wiki.libsdl.org/).