go-sfml

README

go-sfml

Go bindings for SFML, the Simple and Fast Multimedia Library, version 2.5.1

Originally made by teh-cmc

These bindings are entirely generated using SWIG and the official C bindings of SFML.
Hence they should be fairly easy to maintain & keep in sync with future releases from upstream

Table of Contents

• Portability
• Usage
  • Installation
    • First setup
    • Get the module
    • Troubleshooting
      • Error: SFML/Window.h: No such file or directory
      • Error: csfml-window-2.dll could not be found
  • Bat script
  • API
  • Modules
  • Examples
    • Basic example
    • Other examples
• Building go-sfml
  • Download & compile SFML + CSFML
    • Troubleshooting
      • Error: /usr/bin/env: ‘bash\r’: No such file or directory
      • Error: CMake Error [...] Could not find X11 (or a similar error with just another name instead of X11)
  • Setup swig
    • Option 1 - Install it from your package manager
    • Option 2 - Build it locally
    • Troubleshooting
      • Error: /usr/bin/env: ‘bash\r’: No such file or directory
      • Error: Cannot find pcre-config script from PCRE (Perl Compatible Regular Expressions)
  • Build go bindings
    • Troubleshooting
      • Error: /usr/bin/env: ‘bash\r’: No such file or directory
      • Error: swig: command not found
      • Error: Unable to find 'swig.swg'
      • Error: patchelf: command not found

---

Portability

I have only tested these on Windows 10

Feel free to open issues and/or PRs if you're running into problems on other platforms

Usage

Installation

First setup

I'll cover Windows in this section (I build go-sfml using WSL, but build my go apps on Windows)

1. Download CSFML 2.5.1 and extract it wherever you like (assuming C:\CSFML_2.5.1 for the next steps). I'm downloading the 64 bits version since I'm on a 64 bits Windows
2. Download and install the GCC compiler (in my case, the mingw x86_64-win32-sjlj one)
3. We now need to define the CGO_CFLAGS and CGO_LDFLAGS environment variables so the linker knows where the CSFML headers and compiled libraries are at

Assuming CSFML is extracted at C:\CSFML_2.5.1, we can run the following in a command line :

set CGO_CFLAGS="-IC:\CSFML_2.5.1\include"
set CGO_LDFLAGS="-LC:\CSFML_2.5.1\lib\gcc"

Feel free to set those variables system-wide so you don't have to define them on the fly everytime

Notice the -I and -L before the paths, with no whitespace in between

1. Build the example to ensure your setup is working

cd examples/basic_window
go get && go build

1. Copy the CSFML DLLs next to your executable, for the basic example we only need csfml-window-2.dll and csfml-graphics-2.dll that you'll find into C:\CSFML_2.5.1\bin
2. Run the exe, a red window should appear!

Get the module

For future projects, simply run

go get github.com/telroshan/go-sfml/v2

And import the modules you need

import (
  "github.com/telroshan/go-sfml/v2/graphics"
  "github.com/telroshan/go-sfml/v2/window"
  "github.com/telroshan/go-sfml/v2/system"
  "github.com/telroshan/go-sfml/v2/audio"
)

Troubleshooting

Error: SFML/Window.h: No such file or directory

→ Make sure you have downloaded the CSFML version that matches your system (don't download the 32 bits one if you're on a 64 bits Windows)

→ Make sure you included the subfolder matching your compiler (gcc here) for CGO_LDFLAGS, and didn't make it point to the lib root folder itself

→ Make sure you defined the environment variables in the same command line that you ran go build into (the variables defined with the set command won't exist outside of the command line they've been set into)

→ Make sure you typed the variable names correctly, i.e CGO_CFLAGS and CGO_LDFLAGS

→ Make sure you didn't invert the paths between the two variables. CGO_CFLAGS should point to the include folder whereas CGO_LDFLAGS should point to the libs

→ Make sure you made no typo with the syntax of -I and -L for those variables

Error: csfml-window-2.dll could not be found

→ You probably didn't copy CSFML DLLs next to your executable, as mentioned in step 5

Bat script

Alternatively to steps 3 to 5 from the previous section, you could use a bat script to automate that process for you, such as the one in the basic window example

@ECHO OFF

rem This script sets the environment variables to be able to build the app, and copies the CSFML DLLs over if there aren't any in the folder

rem Edit the CSFML_PATH variable to match the path of your CSFML installation
set CSFML_PATH=C:\CSFML_2.5.1
rem Edit the COMPILER_NAME variable if you're not using gcc
set COMPILER_NAME=gcc

set CGO_CFLAGS="-I%CSFML_PATH%\include"
set CGO_LDFLAGS="-L%CSFML_PATH%\lib\%COMPILER_NAME%"

go get
if %ERRORLEVEL% NEQ 0 (echo go get failed && exit /b %ERRORLEVEL%)

go build
if %ERRORLEVEL% NEQ 0 (echo go build failed && exit /b %ERRORLEVEL%)

echo Build complete

if not exist "%~dp0*.dll" (
  echo No DLLs in folder, getting them from CSFML folder
  xcopy /s "%CSFML_PATH%\bin" "%~dp0"
  if %ERRORLEVEL% NEQ 0 (echo failed to copy DLLs && exit /b %ERRORLEVEL%)
)

API

The generated APIs very closely follow those of SFML's C bindings: the tutorials & documentation available for the official C++ implementation, as well as an editor with a well configured Go-autocompletion, will get you a long way

Modules

The original C & C++ implementations of SFML come with 5 modules: Audio, Graphics, Network, System and Window

Of these 5 modules:

• Audio, Graphics & Window come with complete Go packages counterparts
• System also has a dedicated Go package, but only contains the sfVector2 & sfVector3 classes; everything else is already available in one form or another in Go's standard library
• Network has been entirely discard, use Go's standard library instead

Examples

Basic example

Here's a straightforward example of creating a window and handling events:

package main

import (
	"runtime"

	"github.com/telroshan/go-sfml/v2/graphics"
	"github.com/telroshan/go-sfml/v2/window"
)

func init() { runtime.LockOSThread() }

func main() {
	vm := window.NewSfVideoMode()
	defer window.DeleteSfVideoMode(vm)
	vm.SetWidth(800)
	vm.SetHeight(600)
	vm.SetBitsPerPixel(32)

	/* Create the main window */
	cs := window.NewSfContextSettings()
	defer window.DeleteSfContextSettings(cs)
	w := graphics.SfRenderWindow_create(vm, "SFML window", uint(window.SfResize|window.SfClose), cs)
	defer window.SfWindow_destroy(w)

	ev := window.NewSfEvent()
	defer window.DeleteSfEvent(ev)

	/* Start the game loop */
	for window.SfWindow_isOpen(w) > 0 {
		/* Process events */
		for window.SfWindow_pollEvent(w, ev) > 0 {
			/* Close window: exit */
			if ev.GetXtype() == window.SfEventType(window.SfEvtClosed) {
				return
			}
		}
		graphics.SfRenderWindow_clear(w, graphics.GetSfRed())
		graphics.SfRenderWindow_display(w)
	}
}

For comparison's sake, the exact same thing in C:

#include <SFML/Window.h>
#include <SFML/Graphics.h>

int main() {
    sfVideoMode mode = {800, 600, 32};
    sfRenderWindow* window;
    sfEvent event;

    /* Create the main window */
    window = sfRenderWindow_create(mode, "SFML window", sfResize | sfClose, NULL);
    if (!window)
        return 1;

    /* Start the game loop */
    while (sfRenderWindow_isOpen(window)) {
        /* Process events */
        while (sfRenderWindow_pollEvent(window, &event)) {
            /* Close window : exit */
            if (event.type == sfEvtClosed)
                sfRenderWindow_close(window);
        }
        /* Clear the screen */
        sfRenderWindow_clear(window, sfRed);
        sfRenderWindow_display(window);
    }

    /* Cleanup resources */
    sfRenderWindow_destroy(window);
}

Other examples

You'll find other examples in the examples folder

1. Basic window : just the same as above
2. Tennis : go version of SFML's tennis example

Feel free to open PRs if you have any example you'd like to share!

Building go-sfml

If you just want to use go-sfml for SFML 2.5.1 into your go project, you may want to read the Usage section instead

If you want to build your own bindings for a different version of SFML, then this section is for you!

Note: the following steps were realized in Windows' Ubuntu bash. Feel free to open issues and/or PRs if you're running into problems on other Unix-based platforms

Download & compile SFML + CSFML

1. Install SFML dependencies first
2. Run the sfml.sh script to handle the process of downloading SFML/CSFML and compiling them for you

Troubleshooting

Error: /usr/bin/env: ‘bash\r’: No such file or directory

→ You're probably having CRLF issues (happened to me when cloning the repo on Windows initially before switching to WSL)

→ Use dos2unix (install it if you don't have the command) on the 3 scripts : dos2unix sfml.sh swig.sh build.sh

Error: CMake Error [...] Could not find X11 (or a similar error with just another name instead of X11)

Could not find X11
Call Stack (most recent call first):
  src/SFML/Window/CMakeLists.txt (find_package)

→ You probably didn't install every SFML dependency. Don't forget the development headers as well! For example on Ubuntu, you'll want to install libx11-dev, xorg-dev, libudev-dev, and so on

Setup swig

Option 1 - Install it from your package manager

1. Depending on your platform, you may simply download the available package. For example on Ubuntu, sudo apt install swig

Option 2 - Build it locally

1. Run sudo apt install libpcre3-dev (swig requires this package)
2. Run the swig.sh script
3. Check where swig thinks its lib is, by running ./swig/swig -swiglib. It should output ${path/to/go-sfml}/swig/Lib
4. If the output doesn't match, fix that by overriding the SWIG_LIB environment variable. You may run export SWIG_LIB=${path/to/go-sfml}/swig/Lib to override the var just for your current session, or make it persistent
5. Run ./swig/swig -swiglib again to ensure swig has the correct path to its own lib
6. Update the build.sh script and change the line 23 : the script is looking for a global command swig, you must replace that path by ./swig/swig to use the local build instead

Troubleshooting

Error: /usr/bin/env: ‘bash\r’: No such file or directory

→ You're probably having CRLF issues (happened to me when cloning the repo on Windows initially before switching to WSL)

→ Use dos2unix (install it if you don't have the command) on the 3 scripts : dos2unix sfml.sh swig.sh build.sh

Error: Cannot find pcre-config script from PCRE (Perl Compatible Regular Expressions)

→ You probably didn't install libpcre3-dev as mentioned in step 1. Run sudo apt install libpcre3-dev and try again

Build go bindings

1. Run sudo apt install patchelf (the build script uses this package to fix the missing links from the built CSFML libraries to the SFML ones)
2. Run build.sh

Troubleshooting

Error: /usr/bin/env: ‘bash\r’: No such file or directory

→ You're probably having CRLF issues (happened to me when cloning the repo on Windows initially before switching to WSL)

→ Use dos2unix (install it if you don't have the command) on the 3 scripts : dos2unix sfml.sh swig.sh build.sh

Error: swig: command not found

→ You probably either did not install the swig package, or built it locally but forgot to follow the step 6 to update the path used by the build.sh script

Error: Unable to find 'swig.swg'

→ You probably went for the swig local build, but didn't check for its lib path. Please follow steps 3 to 5 of that section

Error: patchelf: command not found

→ You probably didn't install patchelf as mentioned in step 1

You're now ready to go!

Feel free to open issues and/or PRs if you're running into problems that are not mentioned in the troubleshooting sub-sections