Skip to content

Latest commit

 

History

History
109 lines (72 loc) · 3.06 KB

BuildingForEveryPlatform.md

File metadata and controls

109 lines (72 loc) · 3.06 KB
Raw

Introduction

Greetings, one and all. Today we shall explore how to build and deploy a ggez game for every possible platform. For platforms like Linux it's pretty darn simple, but sometimes you have to jump through a couple hoops. The purpose of this is to document the hoops and give you a cookbook on the best jumping methods and trajectories. We will progress generally from the easiest to hardest jumps.

Project setup

We will use the 02_hello_world example program from ggez for all these examples. To do the initial setup, assuming you have cargo installed:

cargo init --bin hello_world
cd hello_world

Now copy-paste the contents of https://raw.githubusercontent.com/ggez/ggez/master/examples/02_hello_world.rs into hello_world/src/main.rs, or if you are on Linux, just wget it:

wget https://raw.githubusercontent.com/ggez/ggez/master/examples/02_hello_world.rs -O src/main.rs

You'll need a font to print "Hello world!" with, so we need to fetch one and put it in a subdirectory called resources in your project root:

mkdir resources
cd resources
wget https://raw.githubusercontent.com/ggez/ggez/master/resources/LiberationMono-Regular.ttf

Then edit your Cargo.toml with your favorite super duper editor and under [dependencies] add:

ggez = "0.9.3"
glam = { version = "0.21", features = ["mint"] }

Now run cargo run and it should build and run! ...maybe. It depends on what platform you're on and what libraries you have installed. To make super-duper sure you have all the bits and pieces in the right places to make this always work, read on!

Linux

Debian

Very easy, just install the required dev packages:

apt install libasound2-dev libudev-dev pkg-config

Then you should be able to build with cargo run

Redhat

Same libraries as Debian, slightly different names. On CentOS 7 at least you can install them with:

yum install alsa-lib-devel

Fedora

dnf install rust-libudev-devel rust-libudev-sys-devel alsa-lib-devel pkgconf-pkg-config

Distributing

You should be able to just copy-paste the executable file and the resources directory to wherever you want.

Windows

Should just build. We recommend using the MSVC toolchain whenever possible, the MinGW one can be pretty jank and difficult to set up.

Distributing

Just copy-paste the exe and resource directory to the destination computer.

MacOS

At the moment we unfortunately cannot provide support for developing on mac (none of the developers have hardware). While ggez tries not to do anything that would make it not work on Mac, it is a DIY target. If you find any issues feel free to open a PR.

Android

Not officially supported yet. ;_; See ggez#70

You might be able to use good-web-game though to run your ggez app on Android.

Web/wasm/emscripten

Not officially supported yet. ;_; See ggez#71

You might be able to use good-web-game though to run your ggez app on wasm.