Summary

Latest Version	Unknown
License	MIT
CI Status	Failing
Downloads	0
Last Indexed	2026-07-21 05:24

Installation

nimble install boxy

choosenim install boxy

git clone https://github.com/treeform/boxy

OS Compatibility

Platform	Linux	macOS	Windows	FreeBSD	OpenBSD	NetBSD	Android	iOS	WASM	Embedded
boxy	✓	✓	✓	-	-	-	-	-	-	-

Source

Repository	https://github.com/treeform/boxy
Homepage	https://github.com/treeform/boxy
Registry Source	nimble_official

README

Boxy - 2D GPU rendering with a tiling atlas.

nimble install boxy

API reference

About

Boxy is an easy to use 2D GPU rendering API built on top of Pixie.

The basic model for using Boxy goes something like this:

Open a window and prepare an OpenGL context.
Load image files like .png using Pixie.
Render any dynamic assets (such as text) into images once using Pixie.
Add these images to Boxy, where they are put into a tiling atlas texture.
Draw these images to screen each frame.

Videos

Basic Example

import boxy, opengl, windy

let windowSize = ivec2(1280, 800)

let window = newWindow("Windy + Boxy", windowSize)
makeContextCurrent(window)

loadExtensions()

let bxy = newBoxy()

# Load the images.
bxy.addImage("bg", readImage("examples/data/bg.png"))
bxy.addImage("ring1", readImage("examples/data/ring1.png"))
bxy.addImage("ring2", readImage("examples/data/ring2.png"))
bxy.addImage("ring3", readImage("examples/data/ring3.png"))

var frame: int

# Called when it is time to draw a new frame.
proc display() =
  # Clear the screen and begin a new frame.
  bxy.beginFrame(windowSize)

  # Draw the bg.
  bxy.drawImage("bg", rect = rect(vec2(0, 0), windowSize.vec2))

  # Draw the rings.
  let center = windowSize.vec2 / 2
  bxy.drawImage("ring1", center, angle = frame.float / 100)
  bxy.drawImage("ring2", center, angle = -frame.float / 190)
  bxy.drawImage("ring3", center, angle = frame.float / 170)

  # End this frame, flushing the draw commands.
  bxy.endFrame()
  # Swap buffers displaying the new Boxy frame.
  window.swapBuffers()
  inc frame

while not window.closeRequested:
  display()
  pollEvents()

Emscripten

Boxy can be compiled to WebAssembly using Emscripten. See the Emscripten tutorial for more information on how Emscripten works with Nim and things you need to know.

To compile any of the examples:

nim c -d:emscripten examples/basic_windy.nim

This will generate: * HTML shell: examples/basic_windy.html * Preloaded data: examples/basic_windy.data * JavaScript: examples/basic_windy.js * WebAssembly: examples/basic_windy.wasm

Then run the compiled HTML file: