VGS-Zero から GBA へのゲームの移植に役立つライブラリとツールセットです。

本SDKは、VGS-Zero用に開発されたゲームをGBAへ移植する用途に特化した仕様にしています。

• グラフィックスは mode0 の 16色/16パレット のみ使用
• map (nametable) は BG0~3 の全面で 32x32 サイズに固定
• 音楽はGB/GBC互換音源のみを使用
• 効果音はPCM (2ch) を使用
• VGS-Zero のグラフィックスと効果音をほぼそのまま移行できるツールチェインを提供
• BGM は Furnace Tracker または hUGETracker での作成を推奨（GB/GBC互換音源の VGM を本SDKで利用できる .psg 形式に変換するツールチェインを提供）

VGS-Zero との仕様差

1. devkitPro でGBAのプロジェクトを作成
2. ソースコードディレクトリに ./src 以下のファイルをコピー
3. #include "gbasdk.h"

API 仕様はヘッダファイルの実装を確認してください。

gbasdk.h は以下の機能別 API のヘッダファイルを #include しています。

• ./tools/bmp2pal/ ... 256色BitmapからGBA形式パレットを生成
• ./tools/bmp2chr/ ... 256色 or 16色BitmapからGBAの16/16形式
• ./tools/wav2pcm/ ... 44100Hz, 16bit, 1ch (VGS-Zero形式) の wav ファイルを GBA 形式（16384Hz, 8bit, 1ch）の RAW PCM データに変換
• ./tools/vgm2psg/ ... Furnace Tracker 等で出力した GB 音源用の VGM ファイルを BGM API が読めるデータ形式に変換

GBAプログラミングの基本については以下のサイトが参考になります。

• https://akkera102.sakura.ne.jp/gbadev/ (日本語)
• https://problemkaputt.de/gbatek.htm (英語)

vdp_wait_vblank (V-BLANKの待機) は、単純に V-BLANK の待機（60fps同期）だけでなく次の処理を含んでいます。

1. BGM の再生
2. 効果音の再生
3. 仮想OAM を VRAM へコピー

音声の再生は、厳密な一定間隔での実行が必要になるため、B-BLANK の検出直後に実行する仕様にしています。

また、OAM (スプライト) の更新処理は基本的に WRAM 上で行い、V-BLANK のタイミングで一括して VRAM へ転送することでチラつきの発生を抑止しています。なお、BG については（VRAMサイズが大きいため）vdp_ 関数で直接 VRAM の更新をしているため、vdp_wait_vblank 呼び出し後は BG を更新する処理を実行することが望ましいと考えられます。

描画優先順位は本SDKでは以下に固定しています。

1. BG3 (フェードアウト・フェードインなど)
2. BG2 (スコアやステータス表示など)
3. Sprite (キャラクタなど)
4. BG1 (マップ上のオブジェクトなど)
5. BG0 (マップなどの優先度が低い表示)

本SDKでは、スプライトの拡大縮小や回転機能について、通常のGBAプログラミングとは異なる独自設計の仕様に 制限 しています。

通常のGBAプログラミングでは、ハードウェアアフィン変換の機能を駆使することで自由度の高い拡大縮小・回転などの変形ができますが、本SDKでは 22.5度単位の16方向の回転、15度単位の4方向の回転、0.5倍単位の4種類の拡大縮小（0.5, 1.0, 1.5, 2.0） のみ利用できる形になっています。

拡大縮小または回転を行いたいスプライトは、vdp_oam_init の引数2に ON を指定します。

void vdp_oam_init(
    OAM* oam,   // target OAM
    int transform, // 0: disable, not0: enable
    int shape,  // type of size ... 0: 8x8,16x16,32x32,64x64 | 1: 16x8,32x8,32x16,64x32 | 2: 8x16,8x32,16x32,32x64
    int ptn,    // pattern index number (0-511)
    int size,   // pattern size (0-3)
    int palette // palette number (0-15)
);

そして、そのスプライトに対して vdp_oam_scale または vdp_oam_rotate で拡大縮小または回転をすることができます。

/**
 * スプライトを回転
 * rotate:
 * - 0~15 = 0度~338度 (※約22.5度刻み)
 * - 16 = 15度, 17 = 30度, 18 = 330度, 19 = 345度
 *
 * Remarks:
 * - rotate に 20 以上 または 0 未満の値を設定するとバッファオーバライトするので注意
 * - 本関数を呼び出すスプライトは vdp_oam_init で transform に ON を設定する必要がある
 * - 画像によっては見切れる場合がある
 * - 確実に見切れないようにするには vdp_oam_double を ON に設定する必要がある
 */
inline void vdp_oam_rotate(OAM* oam, int rotate);

/**
 * スプライトを拡大 or 縮小
 * scale: 0 = 0.5倍, 1 = 1.0倍, 2 = 1.5倍, 3 = 2.0倍
 *
 * Remarks:
 * - scale に 4 以上 または 0 未満の値を設定するとバッファオーバライトするので注意
 * - 本関数を呼び出すスプライトは vdp_oam_init で transform に ON を設定する必要がある
 * - 2 (1.5倍) 以上で拡大表示と見切れが発生する
 * - 見切れを回避するには vdp_oam_double を ON に設定する必要がある
 */
inline void vdp_oam_scale(OAM* oam, int scale);

Hello, World! を表示する簡単な実装例を提供しています。

• ビルド環境の OS は macOS or Linux をサポートしています
• devkitPro で構築した開発環境での利用を想定しています
• example の実行には mgba が必要です
  • macOS: brew install mgba
  • Linux: apt install mgba

上記が整った環境で以下のコマンドを実行すれば ビルド & 実行 ができます。

git clone https://github.com/suzukiplan/gbasdk
cd gbasdk/example
make

• ジョイパッドの上下左右を押すことで HW スクロール機能を用いて Hello, World! を 8 方向に動かすことができます
• スタートボタンを押すことで効果音が鳴ります

詳細は ./example/src/example.c の実装をご確認ください。

MIT