This guide will take you through setting up a development environment for EmptyEpsilon on a windows machine.
It is published as part of a gist containing configuration files that are specific to this set-up. you will be asked to copy them to the project's folder.
This guide assumes you want to create a 32 bit application.
Note that I'm experiencing issues producing a good 32 bit release. There seems to be a problem with linker optimizations as well as ERROR_ACCESS_VIOLATION of SFML using libstdc++-6.dll. However, building and running a debug binary works fine. To produce windows production releases, I'm using an automated script that can be found here
In order to set up a windows development environment for EmptyEpsilon, you need to install the following applications.
These applications (as do most free windows tools) can be installed using Chocolatey to save the trouble.
-
Git.
This tutorial seems reasonable, except that I choseopenSSLinstead ofWindows Secure Channel, assuming openSSL will be better documented and addressed in mainstream git-related tutorials.
Speaking of, you should also create an SSH key and connect it to your github account.
Also, configure your git
Verify installation of git by using it in a new command prompt:git --versionshould print something likegit version {...}
Also, verify ssh connection to github -
CMake version 3.12.2 at least.
Verify installation of cmake by using it in a new command prompt:cmake --versionshould print something likecmake version 3.12.2
Cmake is basically 'yo-dog I hear you like build configurations so here's a build configuration system to configure your build configuration system'. It compiles 3rd party build configurations from its own build configurations. -
ninja.
Verify installation of ninja by using it in a new command prompt:ninja --versionshould print something like1.7.2
Ninja is a build tool. If you want to use more standard build tools, you can choose to use visual studio (not vscode) build tool, or makefiles. Just download, install and configure accordingly. -
vscode with these extensions:
- make a folder, we'll call it
workspace - clone EmptyEpsilon and SeriousProton into workspace
workspace> git clone [email protected]:daid/EmptyEpsilon.git
Cloning into 'EmptyEpsilon'...
{...}
workspace> git clone [email protected]:daid/SeriousProton.git
Cloning into 'SeriousProton'...
{...}
workspaceshould now have two subdirs :EmptyEpsilon,SeriousProton. Verify this usingdircommand:
workspace>dir /w
{...}
[.] [..]
[EmptyEpsilon] [SeriousProton]
{...}
- create folder
workspace/EmptyEpsilon/.vscodeand put the content of this gist inside - download SFML 2.5.1 for windows 32 bit and extract it to
workspace workspaceshould now have three subdirs :EmptyEpsilon,SeriousProton,SFML-2.5.1- download MinGW GCC-7.3.0 windows 32 bit (dwarf) and extract it to
workspace.
notice that this version has to exactly match the version used to build SFML, so if at some point you update one you'd need to update the other (for example, if you want to compile for 64 bit). SFML usually provide good reference for that in their downloads page. workspaceshould now have four subdirs :EmptyEpsilon,SeriousProton,SFML-2.5.1,mingw32- download drmingw for windows 32 bit and extract it to
workspace workspaceshould now have five subdirs :EmptyEpsilon,SeriousProton,SFML-2.5.1,mingw32,drmingw-0.8.2-win32- edit the file
EmptyEpsilon/CmakeLists.txt: replace the line:
find_package(SFML 2.3 REQUIRED system window graphics network audio)
with the lines:
cmake_policy(SET CMP0074 NEW)
find_package(SFML 2.5 COMPONENTS system window graphics network audio REQUIRED)
- open a new vscode window, you should see a welcome message.
- in vscode, choose
file > Add Folder to Workspaceand choose theworkspace\EmptyEpsilonfolder. - at the top of the window, a selection list will appear, prompting you to select a kit choose
local mingw32. you will only have to do this once. Then it will bootstrap the the build environment for 1-2 seconds.
Press F5 to start the build and debug job. The code will then compile. you will see a lot of action in the console tab. After that, EmptyEpsilon will run in debug mode. how awesome is that? 😎
some of the instructions here don't work for everyone. If you have an issue, read the conversation in the original gist, and see if someone have already faced a similar issue and has come up with a workaround. I will try to keep this file updated with the common issues.
- @schoolmeister 's fix for not finding SFML
- my own temporary hack for dealing with
Syntax error in cmake code when parsing stringerrors
- Read the Known Limitations of debugging C++ in vscode, and remember you're using MinGW. a particularly non intuitive detail to remember :
To set a breakpoint when the application is running {...} press Ctrl-C in the application's terminal.
- Each debug configuration can only run a single instance. I've included two identical run configurations
(gdb) Launchand(gdb) Launch2to aid debugging multiplayer flows quickly. - In this environment, the
Escapekey breaks the debugging. that's either a vs-code default hotkey, or something of the sort. Luckily, in EmptyEpsilon theHomeKey serves the same purpose.
Out of curiosity, how might this tutorial vary for Ubuntu 18.04 LTS. I'm trying to have my development and production compiling on the same Linux machine. This is amazing by the way, thanks for going out of your way to share it!