Manual

From BreadboxWiki
Jump to navigation Jump to search

Setting Up

Prerequisities

Recommended system requirements.

  • OS: Windows 10 (64-bit)
  • Processor: Intel Core i5-760 or equivalent AMD CPU
  • Memory: 8 GB RAM
  • Graphics: NVIDIA GTX 1060 3GB / AMD RX 470 4GB or equivalent (DirectX 11 compatible).
  • Resolution: Designed for Full HD 1080p resolution (1920 x 1080).
  • Storage: 2 GB available space

Minimum system requirements are somewhat less than recommended. We cannot give exact minimum system specifications at this stage of the project. So to be on the safe side, verify that your system CPU and GPU performance are close enough (>80%) compared to recommended setup.


Install Breadbox

Breadbox is available on Steam Early Access.

  1. Download and install Steam client (if you don't already have it).
  2. Create Steam account (if you don't already have one).
  3. Purchase your personal copy of Breadbox from the Steam Store page or using Steam client.
  4. Open your Steam Library and select Breadbox.
  5. Click Install
  6. You are good to go. Click Start.

Initial setup tasks

When you open the Breadbox, it asks you to set up Library locations, select your keyboard layout and install the emulator.

Setup Breadbox Library

Breadbox library will contain the collection of software and manuals you wish to use in the simulator. The installation wizard will try to automatically create the Library for you. You can select the base location and subfolder names for different media. If you prefer a different kind of structure you can later change individual media locations in the Simulator View - Settings - Libraries.

Default structure of Breadbox Library:

..\Breadbox Library
  |- c64
  |  |- books
  |  |- cart
  |  |- disk
  |  |- tape
  |- pet
  |  |- books
  |  |- ...
  |- vic20
  |  |- books
  |  |- ...
Keyboard Mappings

The simulated computers in the Breadbox have only one, fixed keyboard layout available, US-American layout. In order to map your PC-keyboard keys to the simulated computers keys in the best possible way, you need to select the layout (or the closest match) of your PC-keyboard. This selection will be set as default for all the computer models in the simulation. You can later change this in Main Page - Setup or per model in the Simulation View - Settings - Input setting.

Currently available keyboard layouts are:

  • US - American
  • UK - British
  • DE - German
  • ES - Spanish
  • IT - Italian
  • FI - Finnish
  • SE - Swedish

Install emulator

Main page installation wizard will open the emulator installer automatically on the first boot or when it needs to be upgraded. Alternatively you can find emulator version and installer from Main Page - Setup.

Open emulator installer

If the installer has not been already opened.

  1. Click SETUP on the Main Page.
  2. Click Setup or Update depending on which is available.

Emulator installer

  1. On the installer window, note the About VICE tab to find out more about VICE (and VICE IOI) emulator.
  2. To continue into the installation click Next.
  3. Verify the installation path and choose another one if you prefer.
    Note! Please do not include any Windows standard folder (e.g. Program Files) here.
    (Using Windows standard folder would reguire the application to switch to admin mode. This functionality is not yet implemented, so we recommend you use another path here, for example the default path given.)
  4. Click Install
  5. Wait about a minute for download and unpack to finish.
  6. Installation is ready, when you see a text VICE IOI is intalled together with OK button.
  7. Click OK.


After the installation is done, the emulator integration is immediately active on all Commodore brand computers.

You can now turn ON the computers in the simulator and enjoy the simulation with emulation :)


Updating emulator

When a new improved emulator version is available, the Breadbox will ask you to update the emulator. Just follow the same procedure as described above, in the Install Emulator.


Get Started

Main Menu

Main Menu

Main Menu shows all the computers available.

The computer simulation will start by clicking on any computer model image. You can also see specifications of each model by clicking an info icon on the top-right corner of the image.

PET 2001 Simulator Scene

Simulator View

Simulator View is a virtual desktop that displays a simulation of the selected computer and its peripherals.

You can interact with a various items, like diskettes, tapes, switches and buttons with your mouse. You can also change a camera view to a different predefined camera close ups by pointing an object or a hotspot, and using mouse scroll or mouse buttons to trigger the change. Right mouse button will reset the camera view back to default state.

Each computer model has personalized, slightly different simulator view, but they all follow the same UI-logic.

Breadbox is designed for fullscreen mode in 16:9 aspect ratio, but windowed mode is also available. Press F11 to toggle between fullscreen and windowed mode.



Hotspots

In addition to zooming in to different peripherals, scene contains few additional hotspots to allow easy access to some important view angles.

C64 back view C64 side view PET back view
Access the hotspots by hovering the mouse cursor close enough.

Powering Up

When the emulator has been set up, you can power up the computers. Use the hotspots on the simulator view to access the power switches. Turn on the computer by clicking the switch. Depending on the model, you need to turn on the monitor as well. You can also use the shortcut power icon on the bottom-left corner of the screen. It will set all the powers on (or off) for you.

Emulator is an independent component, which handles the computer emulation part. In the end, the quality of the emulation depends on the current state of the emulator in use. In addition to that, there are also many features in the emulator, which are not yet supported in Breadbox integration. Features relevant to simulation may be added later.


Libraries

Floppy Disk Library


Software

Software libraries can contain "image" files of old media formats. The image file contains the content of an entire floppy disk, cassette tape or cartridge. When you have added files (in supported file format) into your library, they will be accessible in the Breadbox simutor view. Open any library from the left-side navigation icons to see your library content for selected media format. When the library panel is open you can search the content, create a new blank (tape or disk), or select any single image file as active content. The active content you have selected, will be displayed in the simulator as a 3D model of cartridge, floppy disk or cassette. You can interact with the selected 3D model in the simulator. Simulated interactions support the most relevant common actions used in the real world, for example, insert/remove disk, insert/eject/play tape, attach/detach cartridge.


Supported File Formats
  • Floppy disks: D64
  • Tape: TAP
  • Cartridge: CRT

Books

You can add manuals, magazines and other kind of documents into the book library. Book library supports files in PDF-format. Activated book will be displayed in the simulator view as a 3D model of a book. You can open the active book in to your PDF-viewer, either by clicking on it in the simulator view or pressing open button in the library. The book cover page will be displayed in the simulator view, if you provide an image file for it. The image file should be in PNG-format and have a same name as the pdf-document.


Keyboard Mappings

Computer keyboard layouts are not what they used to be. A standard PC keyboard does not have all the same keys as a retro computer. Luckily enough, the basic keys are almost all the same.

Breadbox uses symbolic mapping of the keys. Meaning that, most of the time the keys you type on your PC, will 'press' the same keys or the keys that produce the same result on the simulated computer. Some essential keys on the retro computer, which don't have a counter-part on your PC keyboard are mapped to some otherwise available keys. You can easily test the keyboard mapping, by pressing some of the keys on your keyboard and you will notice which keys are pressed down in the simulated computer. As an alternative, you can always use the simulator view to zoom in to the keyboard and click any key with your mouse pointer.

Localization

In case you need to change the keyboard mapping in use, open Main page - Setup and change the keyboard mapping for all computers at once. You can also set the keyboard mapping per model, open the Simulation View - Settings - Input settings and change the keyboard mapping. After the change you need to exit to Breadbox Main page, before the new keyboard layout is activated on the selected computer.

If you feel, that any of the current keyboard mappings is not adequate for your locale, give us a hint and we will add it.

Game Controllers

Simulation view contains a simulated Joystick, in C-64 and VIC-20 simulation. Even though, the standard C-64 supports 2 joysticks, currently only one is implemented.

You can link many regular gamepads and joysticks to the simulated joystick and it will then be interactable in the simulation. The link is created by selecting your game controller as Joystick 1 controller in the Settings - Input settings. And don't forget, in the simulation view, you need to connect the joystick plug into the simulated computer as well, like in the real computer.


Games and Software

Breadbox does not include games or software for the simulated computers.

However, there are hundreds and even thousands of classic games, demos and software available for these computers. Some of them are totally free and most can be considered abandonware. To find games and software or even manuals, try to search The Internet Archive, for example.

Many developers are still creating new games, demos and software for these computers. You can usually buy or get the new ones in many digital formats. It's also a great way to support the developers who created them.

DIY. You can always create the software yourself, find some manuals and learn to code. Or look for old computer magazines that have published type-in programs.


Technical Issues

You can find problems in any software, and Breadbox is not an exception. Some problems are straight forward software bugs and we try to fix those asap. But many problems are more complex and require deeper root cause analysis, before the solution can be found. There can be many layers where the problem lies. For example, the "bug" can be in the original game, corrupted file, the computer hardware or OS (mimicked by the emulator) or in the simulator. Or it can be a missing feature, you know, this software is not yet "ready" and so on. And last, it can also be a user error, when user expects something to work differently than it really does.

You can help this software to become better by analysing the problem and letting us know how it occurs and what is your hardware. You can post the issue in Bugs subforum on Breadbox Steam Community forum or email us at support@bitfall.fi.

In the meantime, you can try to overcome some common problems and occational hiccups with these tips.


Common Problems and Solutions

Slow power up time
When you have a fresh emulator installation and you power up any of the computers for the first time, it can be slow. Subsequent starts are faster.
Computer does not start (emulator is installed)
If the classic power OFF and ON again (simulated computer) doesn't work, normally you can overcome this problem by exiting back to Main Page and trying again. In some rare cases you can also try to restart the Breadbox and/or your PC.
Game Controller doesn't work
First, verify your controller is linked to virtual joystick, open Breadbox Settings - Input settings to see if it is selected. Verify also that the virtual joystick plug is attached to the computer in the Simulator View. Then if the problem persists, detach/attach the joystick plug or verify if you need to use a different control port (C64). Sometimes the classic power OFF and ON (simulated computer) might help.


Verified Game Controllers

A list of Game Controllers verified to work with Breadbox.

Manufacturer Model Controller Name (in Breadbox) Virtual Joystick animation
Logitech F310 Gamepad Controller (Gamepad F310) yes
Microsoft XBOX 360 Controller Controller (XBOX 360 For Windows) yes
retro-bit USB Gamepad USB Gamepad yes
Retro Games The C64 Joystick THEC64 Joystick
Speedlink Competition Pro SPEED-LINK Competition Pro yes
Speedlink Competition Pro Extra Game Controller for android