https://github.com/zoomten/nim-gb-test

Writing Game Boy stuff in Nim through GBDK
https://github.com/zoomten/nim-gb-test

gameboy gbdev nim nim-lang

Last synced: about 1 month ago
JSON representation

Writing Game Boy stuff in Nim through GBDK

• Host: GitHub
• URL: https://github.com/zoomten/nim-gb-test
• Owner: ZoomTen
• Created: 2023-07-16T17:38:16.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-09-11T08:41:07.000Z (over 1 year ago)
• Last Synced: 2023-09-11T09:53:40.793Z (over 1 year ago)
• Topics: gameboy, gbdev, nim, nim-lang
• Language: Nim
• Homepage: https://zumi.neocities.org/bloge/nim_boy
• Size: 36.1 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Nim on GB?

This is an experiment in the vein of [Nim on GBA](https://github.com/hcorion/nim-on-gba) to make Game Boy stuff written in Nim (through GBDK).

![](doc_img/Rebrickd-0.png) ![](doc_img/Rebrickd-1.png)

## What's in here?

- an incomplete set of GBDK bindings (at least they're documented, I guess)

  - `nim_src/gbdk/todo/*.h` are the original GBDK headers with the comments removed (that's the C in the github languages count), they aren't used—it's just to keep track how many functions are accessible from Nim so far :p

- a custom `nimbase.h`

- two ported GBDK examples (`phys` and `scroller`) and a test of my own

- a buggy Arkanoid clone with a *very* (/s) original name: "Rebrick'd"

## What do I need?

Uses neither Nimble nor Nake, but rather plain ol' Make. :p Though, I want to turn the Makefile into Nimble tasks in the future.

Other than that, you'll of course need [GBDK-2020](https://gbdk-2020.github.io). Make sure to edit the Makefile to point to your GBDK installation.

The Makefile contains an `asm-debug` target that compiles to ASM and puts it under `_asmbuild`. Just in case you wanna look at what's in the ROM from the Nim-generated C source.

## Attribution and License Info

* [GBDK-2020](https://github.com/gbdk-2020/gbdk-2020) under [GPLv2 with Linking Exception](https://raw.githubusercontent.com/gbdk-2020/gbdk-2020/develop/licenses/LICENSE_GPLV2_LE)

  * LCC (integrated with GBDK) under the [LCC License](https://raw.githubusercontent.com/gbdk-2020/gbdk-2020/develop/licenses/LICENSE_lcc)

  * (I'm not sure what the GBDK examples are licensed as)

* "Rebrick'd" is based off of the [Unbricked example game](https://gbdev.io/gb-asm-tutorial/part2/getting-started.html) by [Eldred Habert](https://github.com/ISSOtm) and [gb-asm-tutorial contributors](https://github.com/gbdev/gb-asm-tutorial/graphs/contributors), licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).

* `incBin` in `gbdk/misc` module originates from [Natu](https://github.com/exelotl/natu), which is under the [Zlib license](https://raw.githubusercontent.com/exelotl/natu/devel/LICENSE)