Manual: Difference between revisions

From BreadboxWiki
Jump to navigation Jump to search
 
(70 intermediate revisions by the same user not shown)
Line 4: Line 4:
=== Prerequisities ===
=== Prerequisities ===


Recommended system requirements.  
Minimum system requirements.  


* OS: Windows 10 (64-bit)
* '''OS:''' '''Windows 10/11''' (64-bit)
* Processor: Intel Core i5-760 or equivalent AMD CPU
* '''Processor:''' Intel Core i5-760 or equivalent AMD CPU
* Memory: 8 GB RAM
* '''Memory:''' 8 GB RAM
* Graphics: NVIDIA GTX 1060 3GB / AMD RX 470 4GB or equivalent (DirectX 11 compatible).
* '''Graphics:''' NVIDIA GTX 1060 3GB / AMD RX 470 4GB or equivalent (DirectX 11 compatible, Shader Model 5.0).
* Resolution: Designed for Full HD 1080p resolution (1920 x 1080).
* '''Resolution:''' Designed for Full HD 1080p resolution (1920 x 1080).
* Storage: 2 GB available space
* '''Storage:''' 3 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.
The actual minimum system requirements are somewhat less than this. We don't have enough data to give exact minimum system specifications at this stage of the project. To be on the safe side, verify that your graphics card is capable of modern gaming and that your CPU performance is close enough (>80%) compared to the recommended setup. Breadbox allows you to select lower resolution in case the graphics card performance is not adequate.




Line 20: Line 20:
Breadbox is available on Steam Early Access.
Breadbox is available on Steam Early Access.


# Download and install '''Steam client''' (if you don't already have it).
# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# Create '''Steam account''' (if you don't already have one).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# '''Purchase''' your personal copy of '''Breadbox''' from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page] or '''using Steam client'''.
# Open your Steam Library and '''select Breadbox'''.
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install'''
# Click '''Install''' and wait until the installation is finished.
# You are good to go. Click '''Start'''.
# '''Start the Breadbox''' and follow the instructions to complete the initial setup tasks.


==== Initial setup tasks ====
==== Initial setup tasks ====


When you open the Breadbox, it asks you to set up Library locations, select your keyboard layout and install the emulator.
When you first open the Breadbox, it will ask you to set up Library locations, select your keyboard layout, and install the emulator.
 
A short video tutorial about initial setup tasks is available here: [https://youtu.be/z0gy-KOw3KQ Breadbox - Simple Set Up Guide].


===== Setup Breadbox Library =====
===== 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''.
The breadbox library will contain the collection of software and manuals you wish to to utilize within the simulator. The installation wizard will try to automatically create the Library for you. If you want, you can select different base location and subfolder names for various types of 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:''
''Default structure of Breadbox Library:''
Line 53: Line 54:
===== Keyboard Mappings =====
===== Keyboard Mappings =====


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.''
To map your PC keyboard keys to the simulated computer 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.''


''Read more about Breadbox [[Keyboard Mappings]] and available layouts.''
''Read more about Breadbox [[Keyboard Mappings]] and available layouts.''
Line 59: Line 60:
=== Install emulator ===
=== 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'''.
The 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 the emulator version and installer from '''Main Page - Setup'''.


==== Open emulator installer ====
==== Open emulator installer ====
Line 67: Line 68:


==== Emulator installer ====
==== Emulator installer ====
# On the installer window, note the '''About VICE''' tab to find out more about VICE (and VICE IOI) emulator.
# On the installer window, note the '''About VICE''' tab to find out more about the VICE (and VICE IOI) emulator.
# To continue into the installation click '''Next'''.
# To continue into the installation click '''Next'''.
# Verify the installation path and choose another one if you prefer.<br />''Note! Please do not include any Windows standard folder (e.g. Program Files) here.<br />(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.)''
# Verify the installation path and choose another one if you prefer.<br>''Note! Please do not include any Windows standard folder (e.g. Program Files) here.<br>(Using Windows standard folder would require 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.)''
# Click '''Install'''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is intalled''' together with '''OK''' button.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# Click '''OK'''.
# Click '''OK'''.


Line 83: Line 84:
'''Updating emulator'''
'''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'''.
Occasionally the emulator needs to be updated. When the new 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 ==
[[File:Breadbox Main Menu.png|thumb|Main Page]]
 
=== Main Page ===
 
The Main Page displays all the available computers.
 
To initiate the computer simulation, simply click on an image of any computer model. To access the generic specifications of each model, just click the info icon located in the top-right corner of the image.
 
 
==== Setup ====
 
The Main Page also includes a Setup panel. In the Setup panel, you can configure settings related to graphics, change keyboard language region for all simulated computers, and set up the emulator in case you've missed it in some previous steps.


:'''Emulator Setup'''
:Select this if you need to install or update the emulator.


== Get Started ==
:'''Keyboard mapping'''
[[File:Breadbox Main Menu.png|thumb|Main Menu]]
:Set the keyboard language region for all simulated computers here.
 
:'''Screen resolution'''
:The list contains resolutions available for your hardware and supported by Breadbox. Ideally, you will use your monitor's native resolution or 1920 x 1080 (the default resolution for Breadbox). Then again, in case the Breadbox is a bit heavy for your graphics card, you should try a lower setting to see what works best for you.


=== Main Menu ===
:'''Graphics quality'''
:Set the graphics quality to ''High'' or ''Low''. ''High'' is the default setting, but in case the responsiveness of the UI is slow, you can test if the ''Low'' setting is more suitable for your hardware.


Main Menu shows all the computers available.
:'''Frame rate'''
:Depending on the selected graphics quality, you can choose the optimum frame rate either by setting the '''vertical sync blank count''' or the '''frame rate limit'''. The default frame rate is 60 FPS, but depending on your hardware, you can use a lower frame rate, for example, 30 FPS.


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.


[[File:Breadbox PET 2001 default view.png|thumb|PET 2001 Simulator Scene]]
[[File:Breadbox PET 2001 default view.png|thumb|PET 2001 Simulator View]]


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


Simulator View is a virtual desktop that displays a simulation of the selected computer and its peripherals.
You can interact with various items, like diskettes, tapes, switches, and buttons with your mouse. You can also change a camera view to different predefined camera close-ups by pointing to an object or a hotspot and using mouse scroll or mouse buttons to trigger the change. The right mouse button will reset the camera view back to the default state.


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 a personalized, slightly different simulator view, but they all follow the same UI logic.


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 the windowed mode is also available. Press '''F11''' to toggle between fullscreen and windowed mode.
 
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.




Line 112: Line 132:
==== Hotspots ====
==== Hotspots ====


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


[[File:C64 hotspot cart.png|200px|C64 back view]] [[File:C64 hotspot power.png|200px|C64 side view]] [[File:PET 2001 hotspot.png|200px|PET back view]]
[[File:C64 hotspot cart.png|200px|C64 back view]] [[File:C64 hotspot power.png|200px|C64 side view]] [[File:PET 2001 hotspot.png|200px|PET back view]]
Line 120: Line 140:
=== Powering Up ===
=== 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.
When the emulator has been [[#Install_emulator|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 power icon shortcut 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.''
''Emulator is an independent component, that handles the computer emulation part. In the end, the emulation quality 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.''




Line 132: Line 152:
==== Software ====
==== 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.
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 add files in a supported file format to your library, they become accessible in the Breadbox simulator view. Simply open any library from the left-side navigation icons to see the content for the selected media format. When the library panel is open you can search the content, create a new blank (tape or disk), or activate any individual image file in the simulator by selecting it. The active content you have selected will be displayed in the simulator as a 3D model of a cartridge, floppy disk, or cassette. You can interact with the selected 3D model in the simulator. Simulated interactions support the most common actions used in the real world, for example, insert/remove disk, insert/eject/play tape, and attach/detach cartridge.




===== Supported File Formats =====
===== Supported File Formats =====


:*Floppy disks: D64
:*Floppy disks: D64, G64(Commodore 64)
:*Tape: TAP
:*Tape: TAP
:*Cartridge: CRT
:*Cartridge: CRT
Exact file format compatibility also always depends on the underlying emulator.
''VIC-20 CRT files have a known issue. Cartridge files with a starting address of A000 are the only ones that currently work. In case you wonder, the starting address is often included in the file name.''


==== Books ====
==== 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.
You can add manuals, magazines, and other kinds of documents to the book library. The book library supports files in '''PDF'''-format. The activated book will be displayed in the simulator view as a 3D model of a book. You can open the active book in 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. The cover page is generated automatically from the first page of the PDF. Cover page is just a regular PNG file with the same name as the original PDF. If you wish to change the cover page, you can replace the generated PNG file with your own image. The image file should be in '''PNG'''-format and have the same name as the related pdf document.




=== Keyboard Mappings ===
=== 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 and vice versa. Luckily enough, many keys and symbols are same and the rest can be linked (mapped) together in quite convenient ways.
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 and vice versa. Luckily enough, many keys and symbols are the same and the rest can be linked (mapped) together in quite convenient ways.


''Read more about Breadbox [[Keyboard Mappings]] and available layouts.''
''Read more about Breadbox [[Keyboard Mappings]] and available layouts.''
Line 154: Line 179:
==== Localization ====
==== 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.
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 find that none of the current keyboard mappings are suitable for your country, please let us know and we will add it.


If you find that none of the current keyboard mappings isn't adequate for your locale, give us a hint and we will add it.


=== Game Controllers ===
=== Game Controllers ===


Simulation view contains two simulated joysticks in C-64 and single joystick in VIC-20 simulation.
The simulation view contains two simulated joysticks in C-64 and a single joystick in the VIC-20 simulation.


You can link many regular came controllers (gamepads and joysticks) to the simulated joystick. Joystick will be interactable in the simulation, when linked with a real game controller. The link is created by selecting your game controller as '''Joystick 1 or 2 controller''' in the '''Settings - Input settings'''. And don't forget, in the simulation view, '''you also need to connect the correct joystick plug''' into the simulated computer as well, like in the real computer.
You can link many regular Game Controllers (gamepads and joysticks) or your keyboard numpad to the simulated joystick. The joystick will be interactable in the simulation when linked with a real game controller. The link is created by selecting your game controller as '''Joystick 1 or 2 controller''' in the '''Settings - Input settings'''. And don’t forget, in the simulation view, you also need to '''connect the correct joystick plug''' into the simulated computer, just like you would with a real computer.


'''Supported game controllers can be limited.''' When running the simulated computers, it's up to emulator whether the game controller is supported or not. As the emulator is not part of the Breadbox, there is a chance that we can not help in the matter. Presumably all DirectX supported controllers will work well enough. There can still be some controller buttons which do not work.
'''Support for game controllers can be limited.''' When running the simulated computers, it's up to the emulator whether the game controller is supported or not. As the emulator is not part of the Breadbox, there is a chance that we cannot assist in this matter. Presumably, all DirectInput-supported controllers will work well enough. Refer to the table on '''Breadbox Game Controller support''' to see the current state of compatibility.


''In case your game controller is not working properly and it is supported by the emulator (VICE), please contact our support.''
''In case your game controller is not working properly and it is supported by the emulator (VICE), please contact our support at support@bitfall.fi.''
Additionally, if your controller is working and it's not mentioned in the supported game controllers table, please let us know.


=== Games and Software ===
==== Numpad as a game controller ====


Breadbox does not include games or software for the simulated computers.
You can use the numeric keypad as a game controller with Breadbox. By default, it's already linked to the virtual joystick of the simulator, unless the linked controller has been changed. The easiest way to see if it's linked is to press the numpad keys 4, 5, 6, and 8 and see if the virtual joystick moves. If it's not linked you can configure it in the ''Settings - Input settings'' panel. When the linking is working don't forget that the virtual joystick plug needs to be attached to the computer as well. That is done in the simulation view. First, select the joystick by clicking on it or its connector, and then click on the control port on the computer you want to connect it to.


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 [https://archive.org/ The Internet Archive], for example.
<pre>
Numpad key configuration:
 
  0 - fire


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.
  8 - up            7  8  9
  4 - left            \ | /
  6 - right        4 - o - 6
  5 - down            / | \
  2 - down          1 2/5 3
</pre>


'''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.
==== Breadbox Game Controller support ====


 
Current status of Game Controllers tested with Breadbox
 
== 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 '''correct''' 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 ===
 
List of Game Controllers verified to work with Breadbox.


:{| class="wikitable"
:{| class="wikitable"
Line 209: Line 220:
!|Controller name in Breadbox
!|Controller name in Breadbox
!|Known issues
!|Known issues
|-
|Atari
|Jaguar controller
|?
|Used with a USB adapter
|-
|-
|Logitech
|Logitech
Line 218: Line 234:
|XBOX 360 Controller
|XBOX 360 Controller
|Controller (XBOX 360 For Windows)
|Controller (XBOX 360 For Windows)
|Left-Stick and buttons A, B and X work. Other controllers do not.
|DPAD-controls do not work.
|-
|-
|retro-bit
|retro-bit
|USB Gamepad
|USB Gamepad
|USB Gamepad
|USB Gamepad
|
|-
|RetroFun!
|DB9-USB adapter
|e4you Retro Fun
|
|
|-
|-
Line 228: Line 249:
|The C64 Joystick
|The C64 Joystick
|THEC64 Joystick
|THEC64 Joystick
|
|-
|Retro Games
|The A500 Controller
|THEGamepad
|
|
|-
|-
Line 237: Line 263:
|Speedlink
|Speedlink
|Competition Pro Extra
|Competition Pro Extra
|Game Controller for android
|Game Controller for Android
|Left fire-button is not working
|
|- style="color: red;"
|Microsoft
|XBOX One Controller
|Controller (Xbox One For Windows)
|Does not work!
|- style="color: red;"
|Nintento
|NES Controller
|?
|Does not work! (Used with a USB adapter)
|}
|}


=== 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 free and most can be considered abandonware. To find games and software or even manuals, try to search [https://archive.org/ The Internet Archive], for example.
Many developers are still creating new games, demos, and software for these computers. You can usually buy or get 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 issues involve straightforward software bugs, and we make it a priority to address them as soon as possible. However many problems are more complex and require deeper analysis before a solution can be found. There can be multiple layers where the issue originates. For instance, the bug might be in the simulator, but it can also reside in the original game or in the operating system of the retro computer (ROM). It can also be a missing feature, you know, this software is not yet "ready" and so on. Lastly, user error is another possibility, occurring when users anticipate different behavior than what actually transpires.
You can help this software to become better by analyzing the problem you encountered and letting us know how it occurs and what is your hardware. You can post the issue in ''Bugs subforum'' on '''Breadbox Steam Community''' or email us at '''support@bitfall.fi'''.


List of Game Controllers that are unlikely to work with Breadbox.
In the meantime, see [[FAQ|FAQ]] for some common problems and solutions.


* XBOX One Controller for Windows
----

Latest revision as of 19:34, 27 March 2024

Setting Up

Prerequisities

Minimum system requirements.

  • OS: Windows 10/11 (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, Shader Model 5.0).
  • Resolution: Designed for Full HD 1080p resolution (1920 x 1080).
  • Storage: 3 GB available space

The actual minimum system requirements are somewhat less than this. We don't have enough data to give exact minimum system specifications at this stage of the project. To be on the safe side, verify that your graphics card is capable of modern gaming and that your CPU performance is close enough (>80%) compared to the recommended setup. Breadbox allows you to select lower resolution in case the graphics card performance is not adequate.


Install Breadbox

Breadbox is available on Steam Early Access.

  1. Install Steam client and create your Steam account (if you don't already have it).
  2. Purchase your personal copy of Breadbox using Steam client or from the Steam Store page.
  3. Open your Steam Library and select Breadbox.
  4. Click Install and wait until the installation is finished.
  5. Start the Breadbox and follow the instructions to complete the initial setup tasks.

Initial setup tasks

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

A short video tutorial about initial setup tasks is available here: Breadbox - Simple Set Up Guide.

Setup Breadbox Library

The breadbox library will contain the collection of software and manuals you wish to to utilize within the simulator. The installation wizard will try to automatically create the Library for you. If you want, you can select different base location and subfolder names for various types of 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

To map your PC keyboard keys to the simulated computer 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.

Read more about Breadbox Keyboard Mappings and available layouts.

Install emulator

The 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 the 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 the 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 require 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.)
  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 installed 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

Occasionally the emulator needs to be updated. When the new 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 Page

Main Page

The Main Page displays all the available computers.

To initiate the computer simulation, simply click on an image of any computer model. To access the generic specifications of each model, just click the info icon located in the top-right corner of the image.


Setup

The Main Page also includes a Setup panel. In the Setup panel, you can configure settings related to graphics, change keyboard language region for all simulated computers, and set up the emulator in case you've missed it in some previous steps.

Emulator Setup
Select this if you need to install or update the emulator.
Keyboard mapping
Set the keyboard language region for all simulated computers here.
Screen resolution
The list contains resolutions available for your hardware and supported by Breadbox. Ideally, you will use your monitor's native resolution or 1920 x 1080 (the default resolution for Breadbox). Then again, in case the Breadbox is a bit heavy for your graphics card, you should try a lower setting to see what works best for you.
Graphics quality
Set the graphics quality to High or Low. High is the default setting, but in case the responsiveness of the UI is slow, you can test if the Low setting is more suitable for your hardware.
Frame rate
Depending on the selected graphics quality, you can choose the optimum frame rate either by setting the vertical sync blank count or the frame rate limit. The default frame rate is 60 FPS, but depending on your hardware, you can use a lower frame rate, for example, 30 FPS.


PET 2001 Simulator View

Simulator View

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

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

Each computer model has a 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 the windowed mode is also available. Press F11 to toggle between fullscreen and windowed mode.



Hotspots

In addition to zooming in on different peripherals, the scene contains a few additional hotspots that allow easy access to some important viewing 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 power icon shortcut on the bottom-left corner of the screen. It will set all the powers on (or off) for you.

Emulator is an independent component, that handles the computer emulation part. In the end, the emulation quality 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 add files in a supported file format to your library, they become accessible in the Breadbox simulator view. Simply open any library from the left-side navigation icons to see the content for the selected media format. When the library panel is open you can search the content, create a new blank (tape or disk), or activate any individual image file in the simulator by selecting it. The active content you have selected will be displayed in the simulator as a 3D model of a cartridge, floppy disk, or cassette. You can interact with the selected 3D model in the simulator. Simulated interactions support the most common actions used in the real world, for example, insert/remove disk, insert/eject/play tape, and attach/detach cartridge.


Supported File Formats
  • Floppy disks: D64, G64(Commodore 64)
  • Tape: TAP
  • Cartridge: CRT


Exact file format compatibility also always depends on the underlying emulator.

VIC-20 CRT files have a known issue. Cartridge files with a starting address of A000 are the only ones that currently work. In case you wonder, the starting address is often included in the file name.

Books

You can add manuals, magazines, and other kinds of documents to the book library. The book library supports files in PDF-format. The activated book will be displayed in the simulator view as a 3D model of a book. You can open the active book in 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. The cover page is generated automatically from the first page of the PDF. Cover page is just a regular PNG file with the same name as the original PDF. If you wish to change the cover page, you can replace the generated PNG file with your own image. The image file should be in PNG-format and have the same name as the related 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 and vice versa. Luckily enough, many keys and symbols are the same and the rest can be linked (mapped) together in quite convenient ways.

Read more about Breadbox Keyboard Mappings and available layouts.

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 find that none of the current keyboard mappings are suitable for your country, please let us know and we will add it.


Game Controllers

The simulation view contains two simulated joysticks in C-64 and a single joystick in the VIC-20 simulation.

You can link many regular Game Controllers (gamepads and joysticks) or your keyboard numpad to the simulated joystick. The joystick will be interactable in the simulation when linked with a real game controller. The link is created by selecting your game controller as Joystick 1 or 2 controller in the Settings - Input settings. And don’t forget, in the simulation view, you also need to connect the correct joystick plug into the simulated computer, just like you would with a real computer.

Support for game controllers can be limited. When running the simulated computers, it's up to the emulator whether the game controller is supported or not. As the emulator is not part of the Breadbox, there is a chance that we cannot assist in this matter. Presumably, all DirectInput-supported controllers will work well enough. Refer to the table on Breadbox Game Controller support to see the current state of compatibility.

In case your game controller is not working properly and it is supported by the emulator (VICE), please contact our support at support@bitfall.fi. Additionally, if your controller is working and it's not mentioned in the supported game controllers table, please let us know.

Numpad as a game controller

You can use the numeric keypad as a game controller with Breadbox. By default, it's already linked to the virtual joystick of the simulator, unless the linked controller has been changed. The easiest way to see if it's linked is to press the numpad keys 4, 5, 6, and 8 and see if the virtual joystick moves. If it's not linked you can configure it in the Settings - Input settings panel. When the linking is working don't forget that the virtual joystick plug needs to be attached to the computer as well. That is done in the simulation view. First, select the joystick by clicking on it or its connector, and then click on the control port on the computer you want to connect it to.

Numpad key configuration:
   
   0 - fire

   8 - up             7  8  9
   4 - left            \ | /
   6 - right         4 - o - 6
   5 - down            / | \
   2 - down           1 2/5 3

Breadbox Game Controller support

Current status of Game Controllers tested with Breadbox

Manufacturer Model Controller name in Breadbox Known issues
Atari Jaguar controller ? Used with a USB adapter
Logitech F310 Gamepad Controller (Gamepad F310)
Microsoft XBOX 360 Controller Controller (XBOX 360 For Windows) DPAD-controls do not work.
retro-bit USB Gamepad USB Gamepad
RetroFun! DB9-USB adapter e4you Retro Fun
Retro Games The C64 Joystick THEC64 Joystick
Retro Games The A500 Controller THEGamepad
Speedlink Competition Pro SPEED-LINK Competition Pro
Speedlink Competition Pro Extra Game Controller for Android
Microsoft XBOX One Controller Controller (Xbox One For Windows) Does not work!
Nintento NES Controller ? Does not work! (Used with a USB adapter)

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 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 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 issues involve straightforward software bugs, and we make it a priority to address them as soon as possible. However many problems are more complex and require deeper analysis before a solution can be found. There can be multiple layers where the issue originates. For instance, the bug might be in the simulator, but it can also reside in the original game or in the operating system of the retro computer (ROM). It can also be a missing feature, you know, this software is not yet "ready" and so on. Lastly, user error is another possibility, occurring when users anticipate different behavior than what actually transpires.

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

In the meantime, see FAQ for some common problems and solutions.