Arduboy Documentation

Documentation

Welcome to the documentation for version 1.1.0 of the core Arduboy library.

Getting started

  1. Library overview
  2. Frequently Asked Questions
  3. Installation guide
  4. "Hello World", your first program

Tutorial: Step-by-step creation of a simple app

Learn by programming a simple game from start to finish, with each section covering another useful feature of the library.

Need ideas. Something simple, doesn't have to be a game... borrow an existing demo?

  1. Starting a new project
  2. (This should be like Hello World except you actually go somewhere.)
  3. ...

The essentials

  1. Text
    1. The drawChar function
    2. Printing numbers and strings
    3. Setting the text location and wrapping
    4. Setting the text size
  2. Drawing
    1. Basic drawing functions
    2. Drawing filled shapes
    3. Drawing lines
  3. Images
    1. The native image format
    2. Drawing native images
    3. Horizontally-oriented (slow) images
  4. Audio
    1. The included audio API
    2. ArduboyTunes class
    3. The ArduboyTunes score format

References

Useful references for dealing with the Arduboy or this library.

  1. Arduino language reference
  2. Library API documentation
  3. How to Reset Arduboy if it’s Bricked
  4. Image Converter