Griddly

A cross platform grid-based research environment that is designed to be able to reproduce grid-world style games.

Build Status

OS	Status
Linux
Windows
MacOS

Community

Join the Discord community for help and to talk about what you are doing with Griddly!

Documentation

This documentation is only for building from source.

Full documentation can be found here: griddly.readthedocs.org

Installing Without Building Locally

Python

To install Griddly without building from source just install from pypi:

pip install griddly

Java (Coming Soon)

Java library support will be developed using JavaCpp

Building locally

Firstly sync up the git submodules:

git submodule init
git submodule update

cmake . -DCMAKE_BUILD_TYPE={Debug|Release}
cmake --build .

Artifacts can then be found in {Debug|Release}/bin

Tests

Test can be run with:

ctest .

Python Installer

To install the built libraries with python you need to do one of the following (depending if your built the binaries with Debug or Release)

The installer should copy the following files into the python/griddly directory:

• resources/* -> python/griddly/resources
• {Release|Debug}/python_griddly.cpython* -> python/griddly/libs

Debug

cd python
python setup.py develop

OR

cd python
pip install -e .

Release

cd python
python setup.py install

Prerequisites

Ubuntu

wget -qO - http://packages.lunarg.com/lunarg-signing-key-pub.asc | sudo apt-key add -
sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-bionic.list http://packages.lunarg.com/vulkan/lunarg-vulkan-bionic.list
sudo apt update
sudo apt install vulkan-sdk

Windows

1. Install cmake
2. Install MinGW (posix 8.1.0) or MSVC
3. Install Vulkan

MacOS

1. Install xcode CLI tools

xcode-select --install

2. Install Brew

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

3. Install cmake

brew install cmake

4. Install Vulkan