Skip to content

Latest commit

 

History

History
84 lines (68 loc) · 2.43 KB

README.md

File metadata and controls

84 lines (68 loc) · 2.43 KB
Raw

boot2flappy Build Status

Flappy Bird for UEFI written in x86 Assembly.

Screenshot

Getting the source

Download the source code by running the following code in your command prompt:

$ git clone https://github.com/fabianishere/boot2flappy.git --recursive

or simply grab a copy of the source code as a Zip file.

Building

We provide two ways for building the project: manually on your local system or in a container using Docker. If installing the required dependencies is not trivial or unwanted, we suggest building the project with Docker.

Make sure you have also downloaded the deps/gnu-efi submodule, which may be done via:

$ git submodule update --init

Manual

Create the build directory.

$ mkdir build
$ cd build

boot2flappy requires CMake and a specific C cross-compiler (namely mingw-w64-x86-64) in order to build. On Ubuntu, please install the following packages:

  • binutils-mingw-w64
  • gcc-mingw-w64-x86-64

Then, simply create the Makefiles:

$ cmake ..

and finally, build it using the building system you chose (e.g. Make):

$ make

Docker

Build the project with the provided fabianishere/boot2flappy container as follows. Make sure you run the command in the project root directory.

$ docker run --rm -it -v `pwd`:/root/boot2flappy fabianishere/boot2flappy

This will build the project in the build/ directory. Since Docker runs as root user, you need to fix the permissions of the build directory in order to run the game:

$ sudo chown -R $USER:$USER build/

Playing

QEMU

After building the project, in the build directory, run the following code in your command prompt:

$ vm/start.sh

This will start a QEMU virtual machine in which you can play the game. Make sure QEMU is installed.

Why

One of the assignments for the Computer Organisation course of 2016 at Delft University of Technology was to create a bootable game in x86 assembly. Why not create a simple EFI game with nice graphics?

License

The code is released under the MIT license. See the LICENSE file.

All sprite files in the resources directory: all copyrights belong to their respective owners. The files are used for education purpose only.