TricksterGuy / nin10kit

(Formerly brandontools) A set of tools for doing homebrew game development, includes look up table generators and and image to C exporter for Nintendo's Gameboy Advance, DS, and 3DS systems. In addition the GUI version of the program allows you to see what the image would look like on real hardware before exporting. Coming soon the ability to edit the bitmap/palette/tilemaps before exporting to the GBA.
Apache License 2.0
49 stars 3 forks source link

nin10kit

(Formerly brandontools)

A set of tools for doing homebrew game development, includes look up table generators and and image to C exporter for Nintendo's Gameboy Advance, DS, and 3DS systems. In addition the GUI version of the program allows you to see what the image would look like on real hardware before exporting.

Table of Contents

Features

Methodology, the image export tool should be smart, there is a lot of artificial difficulty for new users to developing homebrew applications. Things such as knowing the correct flags to set in the Graphics Registers, calculating tile id offsets, or whatever your data would overflow a section of memory should be the tools job. This tool was developed out of my frustration of working with tiled backgrounds, sprites, palettes, and bitmaps.

Installation

Ubuntu/Debian Based Systems

Installing via apt-get

This set of instructions will only work on Ubuntu 18.04 and newer.

Execute these commands:

sudo add-apt-repository ppa:tricksterguy87/nin10kit
sudo apt-get update
sudo apt-get install nin10kit

Compiling with CMake

These instructions will work only on Linux based systems, instructions assume a Debian-based system.

To compile this program you will need the following things installed:

note: The packages may be named libmagick++-dev or libwxgtk3.0-dev on earlier versions of Ubuntu

Once you have that done, cd into the repository folder and follow these instructions:

  1. Create a build directory and go into that directory: mkdir build && cd build
  2. Generate a Makefile with cmake: cmake ..
  3. Then run make to build the binaries: make
  4. Then run make install to install the binaries: sudo make install

Compiling with Visual Studio Code / CMake

Windows

Using precompiled binaries.

Available in Releases. Binaries are compiled in msys2+mingw and compiler gcc.

Compiling with CMake

Coming soon maybe? Its kinda a bother though.

macOS / OSX

Installing via Homebrew

Contributed by skyman.

Install homebrew if you haven't already:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Install nin10kit:

brew install skyman/gt/nin10kit

Compiling with CMake

You need to install CMake, wxMac and ImageMagick 7 (doing this using Homebrew makes things much easier).

Once you have that done, cd into the repository folder and follow these instructions:

  1. Create a build directory and go into that directory: mkdir build && cd build
  2. Generate a Makefile with cmake: cmake -DENABLE_MAGICK7_SUPPORT=ON ..
  3. Then run make to build the binaries: make
  4. Then run make install to install the binaries: sudo make install

Usage

Run the command nin10kit for help using the command line interface and nin10kitgui to launch the GUI application.

License

This project is licensed under the Apache License. More information can be found in the LICENSE file.