Skip to content

quinkennedy/bitbitJAM3

Repository files navigation

bitbitJAM3

central repository for experiments, assets, and game dev for bitbitJAM3: Red Hot Princess Carnage

Overview

bitbitJAM is a 1-week game jam to produce a game targetted for a 8-bit or 16-bit computer or game system. David Frankel, Vivekanand Vimal, and Quin Kennedy are working together to create a game. They are targetting the GameBoy(Color?Advanced?) system.

Game

Undecided. Must incorporate theme of Red Hot Princess Carnage. Interests involve:

  • recursive game mechanics
  • bytebeat audio
  • changing dimensions/modes with color palette swaps

Directory Structure

This repository is broken up into four main parts

  • art/ contains art assets (backgrounds, sprites, fonts) created for the game
  • gbdk/ is the GBDK included as a submodule
  • prod/ is the actual game
  • proto/ contains a series of tests and prototypes

Other folders include

  • tools/ contains some utilities, mainly for producing art assets
  • vagrant_files/ contains Vagrant-specific scripts and configuration files

Dev Setup

Linux:

Most of the development occured on an Ubuntu 16.04 machine. I used Vagrant to create a development sandbox, which means this should work relatively painlessly on Windows or OSX as well.

Dependencies

Setup

  1. git clone --recursive https://github.com/quinkennedy/bitbitJAM3.git
  2. cd bitbitJAM3
  3. vagrant up
  • This will update the Vagrant box with the necessary dependencies and compile the GBDK
  1. vagrant ssh

Usage

When you are logged into the Vagrant guest OS, you can run make from any project directory to build that project into a GameBoy ROM image.

From your host OS you can run the GameBoy ROM image using make run.

OSX

Windows

This was set up on Windows 10, the directions included with the original GBDK were sufficient to get it working.

Dependencies

Setup

  1. download gbdk-2.95-3-win32.zip from the sourceforge site
  2. unzip it to a location you want to "install" it
  • for me that was _D:\appswinx_ , the standard choice would be "C:\Program Files (x86)"
  1. edit your system Path to include GBDK's bin directory
  • I get to it by opening a file explorer, right-clicking on This PC, selecting Properties, selecting the Advanced Systems Settings link on the right, and clicking the Environment Variables button near the bottom
  • Once you have the Environment Variables dialog open, you can edit an existing User variable (if you have one named Path) or create a new User variable named Path
  • add the path to GBDK's bin directory, so if you unzipped to _C:_ it might be C:\Program Files (x86)\gbdk\bin

Usage

There are not scripts for Windows yet, so you need to run lcc -o rom.gb file.c from a command prompt to compile. Where rom.gb would be the name of the output GameBoy rom you want to create, and file.c is the name of the C file to compile.

About

central repository for experiments, assets, and game dev for bitbitJAM3: Red Hot Princess Carnage

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages