ProGearSDK

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 19)

A modern game engine SDK for the NeoGeo AES/MVS.

ProGearSDK Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ProGearSDK

A modern game engine SDK for the NeoGeo AES/MVS.

> **Warning: Alpha Software**
>
> This project is incomplete and under active development. Expect bugs, missing features, and breaking changes without notice. Suitable only for hobbyist experimentation.
>
> **No support is provided.** Issues and questions will not be answered. Use at your own risk.

## Architecture

ProGearSDK uses a three-layer architecture:

```
┌───────────────────────────────────────────────────────┐
│                      Your Game                        │
├───────────────────────────────────────────────────────┤
│               SDK (libprogearsdk.a)                   │
│   Scenes, Actors, Cameras, Physics, UI, Lighting      │
├───────────────────────────────────────────────────────┤
│                 HAL (libneogeo.a)                     │
│   Sprites, Palettes, Input, Audio, Fix Layer, Color   │
├───────────────────────────────────────────────────────┤
│              Core (libneogeo_core.a)                  │
│   Types, Fixed-Point Math, Vectors, Arena Allocator   │
├───────────────────────────────────────────────────────┤
│                   NeoGeo Hardware                     │
│   68000 CPU, VRAM, Palette RAM, Z80 Sound CPU         │
└───────────────────────────────────────────────────────┘
```

- **[Core](core/)** - Foundation library with types, fixed-point math, and memory utilities. No hardware dependencies.
- **[HAL](hal/)** - Hardware Abstraction Layer providing direct access to NeoGeo hardware. Includes all runtime components (startup code, linker script, Z80 driver) needed to build complete applications.
- **[ProGear](progear/)** - High-level game engine with scenes, actors, cameras, and more. Builds on top of Core and HAL.

## Quick Start

```c
#include <progear.h>
#include <progear_assets.h>

int main(void) {
    NGEngineInit();

NGActorHandle player = NGActorCreate(&NGVisualAsset_player, 0, 0);
    NGActorAddToScene(player, FIX(160), FIX(112), 0);

for (;;) {
        NGEngineFrameStart();

if (NGInputHeld(NG_PLAYER_1, NG_BTN_LEFT))  NGActorMove(player, FIX(-2), 0);
        if (NGInputHeld(NG_PLAYER_1, NG_BTN_RIGHT)) NGActorMove(player, FIX(2), 0);

NGEngineFrameEnd();
    }
}
```

## Building

```bash
make              # Build everything (Core + HAL + SDK + demos)
make core         # Build Core only (core/build/libneogeo_core.a)
make hal          # Build Core + HAL (hal/build/libneogeo.a)
make progear      # Build Core + HAL + ProGear (progear/build/libprogearsdk.a)
make showcase     # Build and run showcase demo
make docs         # Generate API documentation (requires Doxygen)
```

### Running Demos

```bash
cd demos/showcase
make mame         # Build and run in MAME emulator
```

## Project Structure

```
ProGearSDK/
├── core/             # Foundation Library
│   ├── include/      # Core headers (ng_types.h, ng_math.h, ng_arena.h)
│   └── src/          # Core implementation
├── hal/              # Hardware Abstraction Layer
│   ├── include/      # HAL headers (ng_*.h)
│   ├── src/          # HAL implementation
│   ├── startup/      # 68000 startup code (crt0.s)
│   ├── z80/          # Z80 audio driver
│   └── rom/          # ROM support files (linker script, sfix)
├── progear/          # Game Engine SDK
│   ├── include/      # SDK headers
│   └── src/          # SDK implementation
├── demos/
│   ├── showcase/     # Feature demonstration
│   └── template/     # Starter template
└── tools/            # Asset pipeline
```

## Requirements

- **m68k-elf-gcc** - 68000 cross-compiler
- **SDCC** - Z80 assembler (sdasz80)
- **Python 3.8+** with Pillow, PyYAML

### macOS

```bash
brew install m68k-elf-gcc m68k-elf-binutils sdcc
pip install -r requirements.txt
```

## Hardware Reference

| Component | Specification |
|-----------|---------------|
| CPU | Motorola 68000 @ 12 MHz (no FPU) |
| Resolution | 320x224 pixels |
| Sprites | 381 total, 96 per scanline |
| Palettes | 256 palettes × 16 colors |

## Resources

- [NeoGeo Development Wiki](https://wiki.neogeodev.org)
- [68000 Programmer's Reference](https://www.nxp.com/docs/en/reference-manual/M68000PRM.pdf)

## License

MIT License

ProGearSDK

ProGearSDK Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ProGearSDK

ProGearSDK Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README