https://github.com/bmchtech/dusk

DUsK, a library for gameboy advance development
https://github.com/bmchtech/dusk

gameboy gameboy-advance gba gba-dev gba-development gba-game homebrew

Last synced: about 1 month ago
JSON representation

DUsK, a library for gameboy advance development

• Host: GitHub
• URL: https://github.com/bmchtech/dusk
• Owner: bmchtech
• License: gpl-3.0
• Created: 2020-10-21T02:30:46.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-05-18T00:42:45.000Z (over 1 year ago)
• Last Synced: 2024-05-23T07:52:33.440Z (7 months ago)
• Topics: gameboy, gameboy-advance, gba, gba-dev, gba-development, gba-game, homebrew
• Language: C
• Homepage:
• Size: 2.43 MB
• Stars: 41
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-gbadev - dusk - Simple, lightweight, intuitive framework for GBA game development (Toolkits / Other places)

README

        

![icon](media/icon.png)

# dusk

DUsK, a library for gba dev

## media!





## features

+ simple, intuitive C API

+ library integration

    + built in support for TONC, GBFS

+ graphics

    + scene architecture

    + 8bpp texture atlas packing

    + sprite/animation helpers

    + tiled map exporter and loader (via Tiled2GBA)

+ (WIP) saves

## ideas

dusk is built all around the idea of simplicity, clarity, and readability.

the exposed api is minimal, but not limiting.

## samples

sample projects can be found here: https://github.com/redthing1/dusk/tree/main/demo

these demo projects are written simply and cleanly.

they have plenty of comments explaining what and why the code does what it does.

furthermore, they demonstrate many of the different features provided by dusk.

## documentation

in the spirit of simplicity and minimalism, and to back up the claims that dusk is simple and easy:

documentation is provided in the literate style, interspersed within a few header files.

these header files contain the entirety of the dusk core api.

view these self documenting files here: https://github.com/redthing1/dusk/tree/main/src/dusk/include

## hacking

### requirements

+ devkitARM's `gba-dev` ([setup](https://devkitpro.org/wiki/Getting_Started))

+ [Tiled2GBA](https://github.com/LucvandenBrand/Tiled2GBA/tree/master/converter) converter in path as `Tiled2GBA`

+ [crunch](https://github.com/xdrie/crunch) atlas packer in path as `crunch_gen`

### build

enter `demo/DuskDemo` and run:

```sh

make

```

this will output `DuskDemo.gba`, which can be loaded up in your favorite GBA emulator.