https://github.com/ftsf/nico

a Game Framework in Nim inspired by Pico-8.
https://github.com/ftsf/nico

game-development game-engine game-engine-2d game-framework gamedev nim

Last synced: about 2 months ago
JSON representation

a Game Framework in Nim inspired by Pico-8.

• Host: GitHub
• URL: https://github.com/ftsf/nico
• Owner: ftsf
• License: mit
• Created: 2016-12-10T01:01:07.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2024-07-09T00:20:43.000Z (6 months ago)
• Last Synced: 2024-08-02T14:08:41.273Z (5 months ago)
• Topics: game-development, game-engine, game-engine-2d, game-framework, gamedev, nim
• Language: Nim
• Homepage:
• Size: 3.86 MB
• Stars: 624
• Watchers: 21
• Forks: 36
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nim - nico - Nim Game Framework based on Pico-8. (Game Development / Game Frameworks)

README

        
# NICO Game Framework

[![test](https://github.com/ftsf/nico/workflows/test/badge.svg)](https://github.com/ftsf/nico/actions)

NICO is a simple game framework for the [Nim](http://nim-lang.org/) programming language inspired by the [PICO-8](https://www.lexaloffle.com/pico-8.php) API.

## Supported platforms:

 * Windows

 * Linux, including RaspberryPi

 * Web/HTML5 via Emscripten

 * Android

 * MacOS

## What it does:

 * Paletted Bitmap Graphics (you can load a custom palette up to 256 colors)

 * Fixed or flexible custom display resolution with pixel scaling

 * Sprite drawing, load png spritesheets, specify tile size per sheet (can load multiple and switch between them)

 * Tilemap drawing, import json from Tiled

 * Drawing primitives: pixels, lines, rectangles, circles, triangles

 * Input: Keyboard, Gamepad, Mouse, Touch

 * Sfx playback: load and play ogg vorbis files, configurable number of mixer channels.

 * Built in chip synth

 * Music playback: stream ogg vorbis files.

 * Custom audio callback for generating your own sounds via code.

 * Text drawing: load and draw fonts from png, supports variable width fonts.

 * Export animated gifs

## Installation

 * You will need to have the Nim compiler installed

 * Run ```nimble install nico```

 * Run ```nicoboot   ``` to create a new directory with an example base ready to start working with.

 * [You can watch a quick tutorial here](https://www.youtube.com/watch?v=czLI5XJFxYA&list=PLxLdEZg8DRwTIEzUpfaIcBqhsj09mLWHx&index=3)

 * Native build:

   * You'll need [SDL2](https://www.libsdl.org/download-2.0.php) for native builds, on Windows, ensure SDL2.dll is copied to your project directory.

   * From your project directory run ```nimble runr``` to build and run the example as a native build.

   * From your project directory run ```nimble rund``` to build and run the example as a debug native build.

 * Web build:

   * For web builds you'll need [Emscripten](https://emscripten.org/docs/getting_started/downloads.html).

   * From your project directory run ```nimble webr``` to build for web in release mode.

   * From your project directory run ```nimble webd``` to build for web in debug mode.

## Learning

 * [API Documentation](API.md)

 * [Examples](examples/)

## Why should you use NICO?

 * It's fun and easy to use

 * Learn Nim the fun way! It's a great new statically typed programming language that compiles to C.

 * You can build for Web, Windows, Linux, Mac, Android, and potentially other platforms.

## Future work:

 * API Documentation

 * More examples

 * Tests

 * Utility modules for common higher level tasks

  * Browser to browser networking using WebRTC

  * Immediate mode GUI

  * 3D Utils and Rasterizer

## Games made using NICO:

 * [Vektor 2089](https://impbox.itch.io/vektor2089)

 * [Smalltrek](https://impbox.itch.io/smalltrek)

 * [Moving in](https://impbox.itch.io/moving-in)

 * [Cute Cats Daily](https://impbox.itch.io/cute-cats-daily)

 * [Super Netwalk Deluxe](https://impbox.itch.io/super-netwalk-deluxe)