Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
81 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,84 @@ | ||
TeleBall | ||
======== | ||
TeleBall - Retro Handheld Game Console | ||
====================================== | ||
|
||
Build your own Arduino based retro handheld game console. | ||
![DeviceInHand](doc/images/intro_breakout.jpg) | ||
|
||
This repository contains the [Jekyll](http://jekyllrb.com) source code | ||
for TeleBall's project website and documentation: | ||
[http://sy2002.github.io/TeleBall](http://sy2002.github.io/TeleBall) | ||
What is TeleBall? | ||
----------------- | ||
|
||
TeleBall is a handheld game console. You cannot buy it. You need to build it | ||
by yourself. It lets you play **BreakOut** in single-player mode using one | ||
device and **Tennis for Two** in multi-player mode using two devices | ||
communicating via radio. | ||
|
||
TeleBall is pretty retro and very minimalistic: It features an | ||
8x8 pixel LED matrix display, a paddle as game controller and one button. | ||
Therefore, the range of possible games is limited but you will be surprised | ||
how much fun and even zenlike meditation this kind of gameplay can bring you, | ||
particularly when you play Tennis for Two with a friend. | ||
|
||
![TennisOnTwoDevices](doc/images/intro_tennis.jpg) | ||
|
||
About this GIT Repository | ||
------------------------- | ||
|
||
This repository contains everything you need to build your own TeleBall | ||
device: | ||
|
||
* CAD .stl and .cmb.gz data for your 3D printer or for any online 3D print | ||
shop to 3D print the TeleBall case | ||
|
||
* Eagle PCB layout for any online PCB manufacturer to make the TeleBall PCB | ||
|
||
* Part lists and hints how to build the hardware | ||
|
||
* Arduino source code to flash the firmware | ||
|
||
TeleBall is made using the | ||
[Arduino Nano platform](http://arduino.cc/en/Main/ArduinoBoardNano) on a | ||
custom PCB. | ||
|
||
Browse TeleBall's [project page](http://sy2002.github.io/TeleBall) | ||
for a much better documentation, including a how-to play and | ||
how-to build guide and a bill of materials (BOM). The project page | ||
is also available offline using `index.html` in the root folder of | ||
this repository. | ||
|
||
### Folder Structure | ||
|
||
cad: CAD data for 3D printing the TeleBall case | ||
Use ".stl" to modify the design or to create a custom output file. | ||
Most online 3D print shops can use the ".cmb.gz" for production. | ||
Made with FreeCad: http://www.freecadweb.org | ||
|
||
doc: HTML documentation; use `index.html` in root folder to browse | ||
|
||
eagle: Electronic schematic diagram including PCB layout. | ||
The libraries.zip files are only needed, if you want to modify | ||
anything; otherwise you can just send the ".brd" file to any | ||
online PCB manufacturing company to receive a TeleBall PCB. | ||
Made with the freeware version of Eagle: http://www.cadsoftusa.com | ||
|
||
src: Arduino source code aka Sketch in the subfolder "TeleBall". | ||
Compile and upload it to your device using Arduino's IDE. You need | ||
to install the libraries from libraries.zip first, before being | ||
able to compile. The "archive" folder contains historic versions. | ||
Made with Arduino: http://arduino.cc/de/Main/Software | ||
|
||
The Makers | ||
---------- | ||
|
||
TeleBall is brought to you by | ||
|
||
* [sy2002](http://www.sy2002.de): idea, code and original circurit design | ||
* doubleflash: additional circurit design and board layout | ||
* lamags: body housing/case | ||
|
||
TeleBall was designed, built and released as an Open Source / Open Hardware | ||
project during August 2014 and January 2015. | ||
|
||
TeleBall is a project of | ||
[MEGA - Museum of Electronic Games & Art](http://www.m-e-g-a.org). | ||
|
||
We are looking forward to hearing from you. Email to sy2002 at teleball.org | ||
|
||
Switch to the [TeleBall Master Repository](https://github.com/sy2002/TeleBall) | ||
to work with the official release package that is including the rendered | ||
HTML version of this documentation. |