Go to file

Christian Kroll 73fac66780 Doxygen: create output in doc, not in docs		2014-03-20 02:01:09 +01:00
doc/img	animated GIF ftw!	2014-03-10 04:22:13 +01:00
ld_scripts	moving source files to dedicated directory	2014-03-18 07:00:13 +01:00
profiles	seasonal animation removed	2013-03-18 14:58:59 +01:00
scripts	moving source files to dedicated directory	2014-03-18 07:00:13 +01:00
src	removed obsolete makefile	2014-03-18 22:05:15 +01:00
.gitignore	Doxygen: create output in doc, not in docs	2014-03-20 02:01:09 +01:00
.gitmodules	fixed rfm12 inclusion, added as submodule	2014-03-18 19:50:26 +01:00
.travis.yml	Add .travis.yml or continuous integration	2014-03-06 19:15:09 +01:00
Doxyfile	Doxygen: create output in doc, not in docs	2014-03-20 02:01:09 +01:00
Makefile	clean target: ignore makefiles in rfm12_lib/examples	2014-03-20 01:45:04 +01:00
README.md	animated GIF ftw!	2014-03-10 04:22:13 +01:00
config.in	moving source files to dedicated directory	2014-03-18 07:00:13 +01:00
defaults.mk	prevented creation of config.mk files in subdirectories	2014-03-20 01:23:36 +01:00
depend.mk	adding menu and game support	2009-01-01 17:06:38 +00:00
rules.mk	moving source files to dedicated directory	2014-03-18 07:00:13 +01:00

README.md

Borgware-2D

Firmware for AVR based two-dimensional LED matrices, especially the Blinken Borgs from Das LABOR. Main platform is the Borg16 construction kit. Other supported platforms are the LED Brett projector from Hackerspace FFM or the ELO Ping-Pong Board.

Animations

Animated GIF (3.5 MB)

Games

Tetris
Classic: Standard Tetris Clone
First Person Tetris: Rotate the bucket instead of the Tetromino.
Bastet: Dices the worst the possible Tetromino the whole time.
Snake
Breakout
Space Invaders

Build

Supported build platforms are Linux, FreeBSD and Windows (via Cygwin). Due to customized linker scripts, simulator support is currently limited to x86 and x86_64 archs. Following dependencies have to be met:

Linux / FreeBSD

Package names are based on Debian/Ubuntu repositories. Please adapt the names according to your Linux distribution (or FreeBSD for that matter).

build-essential (pulls in an ordinary gcc build tool chain for the host)
make (gmake on FreeBSD)
libncurses5-dev
gcc-avr
avr-libc
binutils-avr
avrdude
freeglut3-dev

Windows

WinAVR (includes avr-gcc and avrdude)
Cygwin(64)
- make
- gcc-core
- libncurses-devel (Cygwin)
- libncursesw-devel (Cygwin64)
libusb-win32 if you want to use your USBasp programmer device with avrdude on Windows

Configure

Open a (Cygwin) terminal, change to your checkout directory and type:

make menuconfig

This starts a curses based text interface for configuring certain aspects of your target platform. Be careful if you use an IDE like Eclipse to manage the build, as integrated terminal emulators tend to choke on curses generated shell output. Make sure that 'make menuconfig' has been run at least once in an ordinary terminal emulator after a fresh checkout or after issuing 'make mrproper'.

Compile

To build for the actual target platform, just type:

make

If you want to test and debug your code within a GUI application, you can use the simulator:

make simulator

In case you build on FreeBSD, just use 'gmake' instead of 'make'.

You can start the simulator by typing ./borgsim(.exe)

Simulator Handling

Please keep in mind that the simulator is NOT an emulator. All it does is compile the source to a native host application so you can step through your C-Code. The GUI thread reads the simulated frame buffer every 40ms and draws its contents.

Joystick directions are simulated by the WASD keys and SPACE acts as the fire button. The OpenGL based simulator (Linux/FreeBSD) enables you to adjust the viewing angle of the LED matrix via the arrow keys (not available on Windows).