Documentation
Everything you need to create a game with FRAG
Documentation is still very much a work in progress. Please understand there may be rapid changes to this section of the website.
Nim devel version
Nim is a systems and applications programming language. Statically typed and compiled, it provides unparalleled performance in an elegant package.
Easily install gcc on Windows with Scoop!
Cross-platform, graphics API agnostic, “Bring Your Own Engine/Framework” style rendering library, licensed under permissive BSD-2 clause open source license.
BGFX - Windows Given the above example, you would set the environment variable value to: C:\Users\FragUser\scoop\apps\gcc\current
Initialize the bgfx, bimg, and bx submodules inside the vendor folder of the cloned FRAG repository: BGFX - OSX
Initialize the bgfx, bimg, and bx submodules inside the vendor folder of the cloned FRAG repository: BGFX - Linux
Initialize the bgfx, bimg, and bx submodules inside the vendor folder of the cloned FRAG repository: SDL version 2.0.5 (stable)
Simple DirectMedia Layer is a cross-platform development library designed to provide low level access to audio, keyboard, mouse, joystick, and graphics hardware via OpenGL and Direct3D. It is used by video playback software, emulators, and popular games
including Valve’s award winning catalog and many Humble Bundle games.
SDL officially supports Windows, Mac OS X, Linux, iOS, and Android. Support for other platforms may be found in the source code. SDL is written in C, works natively with C++, and there are bindings available for several other languages, including C# and Python. SDL 2.0 is distributed under the zlib license. This license allows you to use SDL freely in any software. OpenAL version 1.1
OpenAL is a cross-platform 3D audio API appropriate for use with gaming applications and many other types of audio applications.
Docker Community Edition
Docker is the world’s leading software container platform. Developers use Docker to eliminate “works on my machine” problems when collaborating on code with co-workers. Operators use Docker to run and manage apps side-by-side in isolated containers to
get better compute density. Enterprises use Docker to build agile software delivery pipelines to ship new features faster, more securely and with confidence for both Linux and Windows Server apps.
scoop install gcc
Compiling
The Nim compiler currently officially supports the following platform and architecture combinations:
More platforms are supported, however they are not tested regularly and they may not be as stable as the above-listed platforms. Compiling the Nim compiler is quite straightforward if you follow these steps: First, the C source of an older version of
the Nim compiler is needed to bootstrap the latest version because the Nim compiler itself is written in the Nim programming language. Those C sources are available within the nim-lang/csources repository. Next, to build from source you will need:
Then, if you are on a *nix system or Windows, the following steps should compile Nim from source using gcc, git and the koch build tool (in the place of sh build.sh you should substitute build.bat on x86 Windows or build64.bat on x86_64 Windows):
$ git clone https://github.com/nim-lang/Nim.git
$ cd Nim
$ git clone --depth 1 https://github.com/nim-lang/csources.git
$ cd csources
$ sh build.sh
$ cd ../
$ bin/nim c koch
$ ./koch boot -d:releaseNimble
Nimble is Nim’s package manager and it can be acquired from the nim-lang/nimble repository. Assuming that you added Nim’s bin directory to your PATH, you may install
Nimble from source by running:
$ ./koch nimble
Compiling with GCC
Begin by installing gcc, coreutils, and libiconv on your system. We recommend Scoop for an easily installation process. Installing
scoop, along with the dependencies listed above is easy
In PowerShell
:
iex (new-object net.webclient).downloadstring(‘https://get.scoop.sh')
scoop install gcc; scoop install make; scoop install coreutils; scoop install iconv
If you receive an error you might need to update the execution policy (i.e. enable PowerShell) with the foollowing command:
Next you should add an environment variable to your system named MINGW, which points to your gcc installation. Assuming you used Scoop to install gcc, issue the following command to determine where
gcc was installed on your system:
Set-ExecutionPolicy RemoteSigned -scope CurrentUserscoop which gccC:\Users\FragUser\scoop\apps\gcc\current\bin\gcc.exe
git submodule update --init vendor\bgfx vendor\bimg vendor\bx..\bx\tools\bin\windows\genie.exe --with-tools --with-shared-lib --gcc=mingw-gcc gmake
cd .build\projects\gmake-mingw-gcc
make config=release64
Compiling with Clang
git submodule update --init vendor/bgfx vendor/bimg vendor/bx../bx/tools/bin/darwin/genie --with-tools --with-shared-lib --gcc=osx gmake
cd .build/projects/gmake-osx/
make config=release64
Compiling with GCC
git submodule update --init vendor/bgfx vendor/bimg vendor/bx../bx/tools/bin/linux/genie --with-tools --with-shared-lib --gcc=linux-gcc gmake
cd .build/projects/gmake-linux/
make config=release64
Intel 10.5+ Download
Docker is used to compile games built with FRAG
for targets other than the host OS | CPU