Difference between revisions of "Getting started"

From Gamebuino Wiki
Jump to: navigation, search
m (image tags corrected)
m (Fixed grammar errors and made things easier to read. I didn't have to do much! Great english r0d0t!)
Line 5: Line 5:
 
As the indiegogo campaign is over, you can't order a Gamebuino for now. But you can subscribe to the newsletter to know when they'll be available for order again.
 
As the indiegogo campaign is over, you can't order a Gamebuino for now. But you can subscribe to the newsletter to know when they'll be available for order again.
  
== Use my Gamebuino ==
+
== Use your Gamebuino ==
 
[[File:Gamebuino parts.jpg|center]]
 
[[File:Gamebuino parts.jpg|center]]
  
 
=== Turn it on ===
 
=== Turn it on ===
* You just received your Gamebuino, hurray! You should first turn it on to check that nothing has been damaged during shipping. If nothing shows up the battery may be empty or the screen may have moved.
+
* You just received your Gamebuino. Hurray! You should first turn it on to check that nothing has been damaged during shipping. If nothing shows up the battery may be empty or the screen may have moved.
  
 
=== Load games from the micro SD card ===
 
=== Load games from the micro SD card ===
 
[[File:Micro sd loader title screen.jpg|right]]
 
[[File:Micro sd loader title screen.jpg|right]]
 
* Make sure that the provided SD card is correctly inserted in its socket.
 
* Make sure that the provided SD card is correctly inserted in its socket.
* The game browser is named LOADER.HEX. There is several ways to load it:
+
* The game browser is named LOADER.HEX. There are several ways to load it:
 
** Hold down C while you turn the power switch on then release it.
 
** Hold down C while you turn the power switch on then release it.
 
** Press C in the Gamebuino title screen
 
** Press C in the Gamebuino title screen
Line 22: Line 22:
 
[[File:Settings title screen.jpg|right]]
 
[[File:Settings title screen.jpg|right]]
 
* Load SETTINGS.HEX
 
* Load SETTINGS.HEX
* Select "See all settings" to know what can be adjusted. These settings are stored directly in the Gamebuino and will be share between different games.
+
* Select "See all settings" to know what can be adjusted. These settings are stored directly in the Gamebuino and will be shared between different games.
* You should at least adjust these two settings:
+
* You should adjust these two settings at least:
 
** Display contrast
 
** Display contrast
 
** Default username
 
** Default username
* You can let the other settings to their default value, it should be okay.
+
* You can leave the other settings at their default value, it should be okay.
* Don't forget to select "save" before you exit
+
* Don't forget to select "save" before you exit.
  
 
=== Charge the battery ===
 
=== Charge the battery ===
 
* You may want to charge your Gamebuino's battery when you receive it.
 
* You may want to charge your Gamebuino's battery when you receive it.
* To load the battery, you just have to connect your Gamebuino to an USB port (from your computer or an outlet charger) using the provided micro USB cable. The "charging" LED will turn on (the one next to the empty battery logo) until it's fully charged. Then, the "charged" LED will turn on (the one next to the full battery logo).
+
* To load the battery, you just have to connect your Gamebuino to an USB port (from your computer or an outlet charger) using the provided micro USB cable. The "charging" LED will turn on (the one beneath the lightning bolt battery symbol) until it's fully charged. Then, the "charged" LED will turn on (the one beneath to the full battery symbol).
 
* Your Gamebuino will charge faster if turned off.
 
* Your Gamebuino will charge faster if turned off.
 
* A charged battery will give you at least 8 hours of continuous play.
 
* A charged battery will give you at least 8 hours of continuous play.
Line 37: Line 37:
 
=== Remove the paper cover ===
 
=== Remove the paper cover ===
 
[[File:Remove paper cover.jpg]]
 
[[File:Remove paper cover.jpg]]
* The transparent acrylic case is covered with a brown paper protection. Some of you may want to keep it, some may want to remove it.
+
* The transparent acrylic case is covered with a brown paper protection. Some people may want to keep it, some may want to remove it.
 
* First, check that your Gamebuino works fine.
 
* First, check that your Gamebuino works fine.
 
* Dismantle it:
 
* Dismantle it:
Line 54: Line 54:
 
** Screw 4 nylon spacer to hold the PCB in place
 
** Screw 4 nylon spacer to hold the PCB in place
 
** Add the back plate and screw it with the 4 short screws
 
** Add the back plate and screw it with the 4 short screws
** You might want to a spacer between the back plate and the PCB to limit the PCB bending because of screen pressure
+
** You might want to add a spacer between the back plate and the PCB to limit the PCB bending because of screen pressure
  
 
== Upload a program through USB ==
 
== Upload a program through USB ==
Line 110: Line 110:
 
* Note: drivers should be installed automatically on Windows if you used the installer
 
* Note: drivers should be installed automatically on Windows if you used the installer
 
* Drivers are located in the Arduino/drivers folder
 
* Drivers are located in the Arduino/drivers folder
* If you need help to install the drivers, refer to [http://arduino.cc/en/Guide/HomePage the Arduino guide]
+
* If you need help installing the drivers, refer to [http://arduino.cc/en/Guide/HomePage the Arduino guide]
  
 
=== Upload a game ===
 
=== Upload a game ===
Line 141: Line 141:
 
* You're ready to go!
 
* You're ready to go!
  
== How to make my own games ==
+
== How to make your own games ==
* If you never ever programmed, you should read the [http://arduino.cc/en/Tutorial/Foundations Arduino Foundations] page to understand... foundations.
+
* If you never programmed before, you should read the [http://arduino.cc/en/Tutorial/Foundations Arduino Foundations] page to understand... foundations.
 
* You should explore the basic [[Examples]], try to understand them, change things an see what happens. There is a lot of comments in the examples, so it should be easy to understand. If there is something you don't get, take a look at the [http://arduino.cc/en/Reference/HomePage Arduino Reference] for general purpose things, and the Gamebuino [[Reference]] for Gamebuino-specific functions. Open the examples in the Arduino software by clicking File/Examples/Gamebuino/basics.
 
* You should explore the basic [[Examples]], try to understand them, change things an see what happens. There is a lot of comments in the examples, so it should be easy to understand. If there is something you don't get, take a look at the [http://arduino.cc/en/Reference/HomePage Arduino Reference] for general purpose things, and the Gamebuino [[Reference]] for Gamebuino-specific functions. Open the examples in the Arduino software by clicking File/Examples/Gamebuino/basics.
  

Revision as of 2014-08-12T15:36:40

Get a Gamebuino

For an overall presentation head to the home page or indiegogo page.

As the indiegogo campaign is over, you can't order a Gamebuino for now. But you can subscribe to the newsletter to know when they'll be available for order again.

Use your Gamebuino

Error creating thumbnail: Unable to save thumbnail to destination

Turn it on

  • You just received your Gamebuino. Hurray! You should first turn it on to check that nothing has been damaged during shipping. If nothing shows up the battery may be empty or the screen may have moved.

Load games from the micro SD card

Error creating thumbnail: Unable to save thumbnail to destination
  • Make sure that the provided SD card is correctly inserted in its socket.
  • The game browser is named LOADER.HEX. There are several ways to load it:
    • Hold down C while you turn the power switch on then release it.
    • Press C in the Gamebuino title screen
  • Note: You should always get back to the title screen of the game and press 'C' to flash the loader before you turn your Gamebuino off, load another program through USB, or eject the micro SD card. It will avoid to mess up your saved games, as the EEPROM is backed up in a .SAV file when you switch from a game to the loader, and restored when you select a game from the loader.

Change the default settings

Error creating thumbnail: Unable to save thumbnail to destination
  • Load SETTINGS.HEX
  • Select "See all settings" to know what can be adjusted. These settings are stored directly in the Gamebuino and will be shared between different games.
  • You should adjust these two settings at least:
    • Display contrast
    • Default username
  • You can leave the other settings at their default value, it should be okay.
  • Don't forget to select "save" before you exit.

Charge the battery

  • You may want to charge your Gamebuino's battery when you receive it.
  • To load the battery, you just have to connect your Gamebuino to an USB port (from your computer or an outlet charger) using the provided micro USB cable. The "charging" LED will turn on (the one beneath the lightning bolt battery symbol) until it's fully charged. Then, the "charged" LED will turn on (the one beneath to the full battery symbol).
  • Your Gamebuino will charge faster if turned off.
  • A charged battery will give you at least 8 hours of continuous play.

Remove the paper cover

Error creating thumbnail: Unable to save thumbnail to destination
  • The transparent acrylic case is covered with a brown paper protection. Some people may want to keep it, some may want to remove it.
  • First, check that your Gamebuino works fine.
  • Dismantle it:
    • Unscrew the 4 short screws on the back side first
    • Remove the back plate
    • Unscrew the 4 white nylon spacers
    • Remove the PCB
    • Unscrew the 4 long screws on the front side last
  • Remove the paper cover. Be careful not to scratch the acrylic
  • Check that everything still works fine (especially the display)
  • Assemble back your Gamebuino:
    • Be gentle when you tighten the screws or you may damage the nylon spacers
    • Screw the 4 long screws with 4 nylon spacers on the top plate (be careful to put it on the right side)
    • Put the screen holder on the two upper nylon spacer
    • Put the PCB in place, check that buttons are correctly placed int their holes
    • Screw 4 nylon spacer to hold the PCB in place
    • Add the back plate and screw it with the 4 short screws
    • You might want to add a spacer between the back plate and the PCB to limit the PCB bending because of screen pressure

Upload a program through USB

Install the Arduino software

  • Download the Arduino application here and follow instructions to install it.
  • If you're using Windows, you may want to use the Arduino Enhanced Release.
  • Note: If you are using a package manager to install Arduino, make sure it installs Arduino 1.0.5 (version 1.0 won't work).

Install the Gamebuino Library

  • Download and the Gamebuino library
  • Extract the archive
  • Mac users: you can follow this video tutorial.
  • Copy the folders "Gamebuino" and "tinyFat" located in /libraries and paste them in /Arduino/libraries (where you installed Arduino). On Mac: Put them in documents/Arduino/libraries
  • Copy the folder "gamebuino_boot" from the archive to /Arduino/hardware/arduino/bootloaders. On Mac: Right-click the Arduino-Application in your Programs-folder. Select "Show package contents", then search in this folder for "bootloaders" and copy the folder there.
  • To check that the library is correctly installed, start the Arduino software, and click on File/Examples, you should find "Gamebuino".

Add Gamebuino to boards.txt

  • Navigate to the folder where you installed Arduino
  • Open Arduino/hardware/arduino/boards.txt
  • Add the following at the beginning of the file and save it

##############################################################
gamebuino.name=Gamebuino
gamebuino.upload.tool=avrdude
gamebuino.upload.protocol=arduino
gamebuino.upload.maximum_size=30592
gamebuino.upload.maximum_ram_size=2048
gamebuino.upload.speed=115200
gamebuino.bootloader.low_fuses=0xff
gamebuino.bootloader.high_fuses=0xda
gamebuino.bootloader.extended_fuses=0x05
gamebuino.bootloader.path=gamebuino_boot
gamebuino.bootloader.file=gamebuino_boot.hex
gamebuino.bootloader.unlock_bits=0x3F
gamebuino.bootloader.lock_bits=0x0F
gamebuino.build.mcu=atmega328p
gamebuino.build.f_cpu=16000000L
gamebuino.build.core=arduino
gamebuino.build.variant=standard
##############################################################

  • Restart the Arduino Software
  • Now you should be able to set the device to Gamebuino by selecting Tools/boards/Gamebuino in the menu bar.

Install the drivers

  • Note: your Gamebuino should be turned on when you connect it to the computer
  • Note: drivers should be installed automatically on Windows if you used the installer
  • Drivers are located in the Arduino/drivers folder
  • If you need help installing the drivers, refer to the Arduino guide

Upload a game

  • Start the Arduino software
  • Open an example by clicking File/Examples/Gamebuino/ If you don't find it, check that you correctly installed the Gamebuino library
  • Select the right device by selecting Tools/boards/Gamebuino
  • Select the right serial port in Tools/Serial Port. If it's grayed out check that you have correctly installed the drivers, that your Gamebuino is turned on, and that the cable is working and correctly plugged in.
  • Click on "Upload" or press Ctrl+U

You just uploaded your first Gamebuino game, congratulations !

Put games on the micro SD card

  • Game files which can be loaded on the Gamebuino from the SD card are .HEX files.
  • You can get .HEX files of the default programs on GitHub, and .HEX file of other people's games in the forum in the Games Gallery.

Get the .HEX file from your game

  • Start the Arduino software
  • Click on File/Preferences and check "Show verbose output during compilation"
  • Compile your program (Ctrl+R)
  • A lot of text will scroll in the black area at the bottom of the window
  • Find the build directory for your program:
    • Windows: "C:\Users\Username\AppData\Local\Temp\build[random number].tmp\a_Hello.cpp.hex"
    • GNU/Linux: "/tmp/build[random number].tmp/a_Hello.cpp.hex"
  • Note: If you use the Arduino Enhanced Release, just press Ctrl+Alt+R to open the current build folder.
  • Navigate to this folder and find the .hex file with the name of your program
  • Rename it to a 8:3 format: only capitals, 8 characters max for the name and .HEX extension. For example: CRABATOR.HEX or PONG.HEX

Put it on the micro SD card

  • Put that file on your micro SD card using the micro SD adapter provided.
  • You're ready to go!

How to make your own games

  • If you never programmed before, you should read the Arduino Foundations page to understand... foundations.
  • You should explore the basic Examples, try to understand them, change things an see what happens. There is a lot of comments in the examples, so it should be easy to understand. If there is something you don't get, take a look at the Arduino Reference for general purpose things, and the Gamebuino Reference for Gamebuino-specific functions. Open the examples in the Arduino software by clicking File/Examples/Gamebuino/basics.

See Also