BreadboxWiki - User contributions [en]

Manual

2025-12-08T06:56:17Z

Breadbox:

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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.

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Breadbox supports most USB-connected game controllers and joysticks. It also supports original joysticks using the 9-pin Atari standard when used with a compatible USB adapter.

''Wireless controller support is limited and functionality is not guaranteed.''

''In case your game controller is not working properly see the known issues and solutions section. If the issue is not covered, please contact our support at support@bitfall.fi.''

===== Known issues and possible solutions =====

:'''Issue'''
:How to connect original Joystick or Game Controller which have 9-pin Atari standard connector.

:'''Solution'''
:Use compatible DB9-USB adapter, for example: RetroFun! DB9-USB adapter

:'''Issue'''
:Game Controller is working in Breadbox, but doesn't work in the emulator.

:'''Cause'''
:Some controllers (such as the Xbox One Wireless Controller) may use the XINPUT-compliant driver by default in Windows. This driver appears to behave differently from others and blocks controller signals to applications running in the background. Since Breadbox is designed to run the emulator as a background application, this behavior may cause compatibility issues.

:'''Solution'''
:There appear to be two alternative ways to overcome the issue:
:# Using the Windows HID-compliant driver mode
:# Using the Steam-based Xbox Extended Feature Support Driver

:'''1. Using the Windows HID-compliant driver mode'''

:Change the controller's device driver from "XINPUT-compliant" mode to "HID-compliant" mode.

:Note that this may limit some special controller features in other games until the driver is updated back to XINPUT-compliant mode.

:Steps:
:# Open Device Manager in Windows and navigate to Human Interface Devices.
:# Look for "XINPUT-compatible HID device", or search by your controller name if not found.
:# Right-click the controller and select "Update driver".
:# Choose "Browse my computer for drivers".
:# Select "Let me pick from a list of available drivers on my computer".
:# From the list, choose "HID-compliant game controller".
:# Click Next to apply the driver.
:# Restart your computer after completing the update.

:Note: You may need to repeat these steps for the alternate connection mode (wired or wireless) if you intend to use both.

:'''2. Using the Steam-based Xbox Extended Feature Support Driver'''

:Install the Xbox Extended Feature Support Driver provided by Steam.

:Steps:
:# Open Steam → Settings → Controller
:# Install the Xbox Extended Feature Support Driver – This enables Xbox One controllers to function as Xbox 360 controllers
:# Go to your Steam Library and select Breadbox
:# Click the Controller icon on the right side of the game page
:# Enable Steam Input

::Optional mapping adjustments (D-pad to joystick):
::6. Select your Current Button Layout
::7. Browse Community Layouts
::8. Choose the layout titled: "XBOX One Controller to 360"

=== 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'''.

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

----

About Breadbox

2025-12-08T06:54:04Z

Breadbox:

'''BREADBOX''' is a retro computer simulator program.

Available on [https://store.steampowered.com/app/1770440/Breadbox/ Steam].

== Objective ==

The Breadbox aims to faithfully recreate the nostalgic experience of retro computers through an immersive visual simulation.

=== Design and development principles ===
* '''Prioritize Aesthetics:''' Highlight the nostalgic charm by faithfully recreating the original design of retro computers and their peripherals.
* '''Immerse the User:''' Craft an immersive first-person experience where users can explore animated objects, interact with authentic hardware, and hear the nostalgic sounds of vintage computing.
* '''Functional Authenticity:''' Ensure fully operational computers within the simulation, seamlessly integrated with emulators for an authentic retro computing.
* '''Realism in Interaction:''' Create a realistic simulation that mirrors real-life interactions, capturing the essence of those early computing days.

While the principles serve as a guideline for the project, further work is needed to add additional features and align some of the current features more closely with these goals.

== Why ==

The '''Breadbox project''' serves as a time capsule, preserving the essence of a bygone era—the days when 8-bit computers ruled the digital landscape. Here’s why this project matters:

# '''Authentic Nostalgia:''' By meticulously simulating the original environment of retro computers, the '''Breadbox''' allows users to step back in time. It’s not just about software or games; it’s about reliving the tactile joy of clunky keyboards, the glow of pixelated screens, and the whir of cassette tape loading. For those who never owned these vintage machines, the '''Breadbox''' offers an authentic glimpse into computing history.
# '''Vanishing Hardware:''' Vintage computers are becoming increasingly scarce. The project’s urgency lies in capturing their essence while we still have access to working hardware and knowledgeable enthusiasts. The '''Breadbox''' provides a chance to utilize machines that might otherwise be inaccessible, preserving the legacy of these devices.
# '''Visual Emphasis:''' The Breadbox prioritizes aesthetics. It’s not just about functionality; it’s about seeing and feeling the past. Whether you’re a curious newcomer or a seasoned enthusiast, the '''Breadbox''' lets you witness the iconic design and visual quirks of retro computers.
# '''Preserving Culture:''' Through the Breadbox, we safeguard the user experiences of retro computers and various peripherals that shaped an entire generation. It’s a tribute to the pioneers who paved the way for today’s digital world.
# '''Hardware-Less Experience:''' When you crave the look and feel of retro hardware but lack the physical machines, the '''Breadbox''' steps in. Using a simulator keeps your real vintage hardware safe from wear and tear.

In summary, the Breadbox project aims to preserve computing memories, inspire curiosity and celebrate the groundbreaking computers that shaped our digital journey.

== The Project ==

The Breadbox project is an ambitious undertaking, and in reality, it will never reach a definitive endpoint. There will always be new computer models, peripherals, software features, and technical details to implement. As a result, the project will evolve dynamically and iteratively, with additional features and models added incrementally. The pace of progress heavily relies on public interest and support.

=== Project status ===
# Early Access Version Development
#* Creating the initial version of the product with limited features.
#* Focusing on core functionality and gathering user feedback.
# Beta Testing
#* Engaging a select group of users to test the product.
#* Identifying and addressing any issues, bugs, or usability concerns
# Release of Early Access Version
#* Making the product available to a broader audience.
#* Monitoring user adoption and collecting additional feedback.
# Maturing Product for official release
#* Continuously improving the product based on user feedback.
#* Ensuring stability, scalability, and compatibility.
#* Implementing of additional features.
#* Addressing minor issues, enhancing performance, and refining user experience.
#* Preparing for the official launch.
# '''Official Release launch'''
#* Raising awareness
# Post-launch
#* Addressing minor issues, enhancements, and refinements based on user feedback.
#* Introducing new features, expanding capabilities, and adapting to evolving user needs.
#* Determining the subsequent actions based on the product feedback and sales.

=== Simulated Computers ===
:* Commodore PET 2001-8
:* Commodore VIC-20
:* Commodore 64

=== Goals ===

* The goal is to introduce a substantially greater quantity of computers. A successful launch would pave the way for pursuing this goal.

==== Future ====

* '''VR/AR:''' The project already encompasses a significant portion of the technology required for virtual reality creation. When virtual reality (VR) gains wider acceptance and becomes more mainstream, the foundation of the simulator can serve as a solid starting point for developing VR-based solutions.

=== Challenges ===

In summary, developing a retro computer simulator is both challenging and fulfilling. It necessitates resources and backing to keep the project ongoing. With enough support we can continue to develop this product.

==== How to support the project ====

* Purchase the [https://store.steampowered.com/app/1770440/Breadbox/ Breadbox] on Steam Store.
* Go to Steam Store and wishlist the Breadbox.
* Follow on X or on YouTube

== Links ==
* [https://store.steampowered.com/app/1770440/Breadbox/ Breadbox Steam Store page]
* [https://www.youtube.com/channel/UC2nD_faNmYDx2sZvLgEpXWQ Breadbox YouTube Channel]
* [https://twitter.com/BreadboxBitfall Breadbox Twitter/X account]
* [https://www.bitfall.fi Bitfall (Developer)]

Manual

2025-06-13T11:22:20Z

Breadbox:

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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.

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Breadbox supports most USB-connected game controllers and joysticks. It also supports original joysticks using the 9-pin Atari standard when used with a compatible USB adapter.

''Wireless controller support is limited and functionality is not guaranteed.''

''In case your game controller is not working properly see the known issues and solutions section. If the issue is not covered, please contact our support at support@bitfall.fi.''

===== Known issues and possible solutions =====

:'''Issue'''
:How to connect original Joystick or Game Controller which have 9-pin Atari standard connector.

:'''Solution'''
:Use compatible DB9-USB adapter, for example: RetroFun! DB9-USB adapter

:'''Issue'''
:Game Controller is working in Breadbox, but doesn't work in the emulator.

:'''Cause'''
:Some controllers (such as the Xbox One Wireless Controller) may use the XINPUT-compliant driver by default in Windows. This driver appears to behave differently from others and blocks controller signals to applications running in the background. Since Breadbox is designed to run the emulator as a background application, this behavior may cause compatibility issues.

:'''Solution'''
:There appear to be two alternative ways to overcome the issue:
:# Using the Windows HID-compliant driver mode
:# Using the Steam-based Xbox Extended Feature Support Driver

:'''1. Using the Windows HID-compliant driver mode'''

:Change the controller's device driver from "XINPUT-compliant" mode to "HID-compliant" mode.

:Note that this may limit some special controller features in other games until the driver is updated back to XINPUT-compliant mode.

:Steps:
:# Open Device Manager in Windows and navigate to Human Interface Devices.
:# Look for "XINPUT-compatible HID device", or search by your controller name if not found.
:# Right-click the controller and select "Update driver".
:# Choose "Browse my computer for drivers".
:# Select "Let me pick from a list of available drivers on my computer".
:# From the list, choose "HID-compliant game controller".
:# Click Next to apply the driver.
:# Restart your computer after completing the update.

:Note: You may need to repeat these steps for the alternate connection mode (wired or wireless) if you intend to use both.

:'''2. Using the Steam-based Xbox Extended Feature Support Driver'''

:Install the Xbox Extended Feature Support Driver provided by Steam.

:Steps:
:# Open Steam → Settings → Controller
:# Install the Xbox Extended Feature Support Driver – This enables Xbox One controllers to function as Xbox 360 controllers
:# Go to your Steam Library and select Breadbox
:# Click the Controller icon on the right side of the game page
:# Enable Steam Input

::Optional mapping adjustments (D-pad to joystick):
::6. Select your Current Button Layout
::7. Browse Community Layouts
::8. Choose the layout titled: "XBOX One Controller to 360"

=== 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'''.

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

----

Main Page

2024-05-31T10:04:27Z

Breadbox: rvv

== Welcome to the BreadboxWiki ==

BreadboxWiki contains information, manual, news and FAQs about BREADBOX, a retro computer simulator program.

Main Page

2024-05-31T09:53:01Z

Breadbox: Reverted edits by Breadbox (talk) to last revision by YTZAntonietta

Revitalize Your Samsung Galaxy: Specialist Display and Battery Repair Service Solutions Is your Samsung Galaxy gadget looking for display or battery repair work? Look no further than Gadget Kings PRS, where we specialize in giving excellent repair work solutions for a vast array of Samsung Galaxy models. From the Samsung Galaxy S9 And also to the most recent Samsung Galaxy S21 collection, our experienced technicians are equipped to deal with all your repair needs, ensuring that your gadget functions optimally as soon as again. Comprehensive Display and Battery Repair Solutions Display Fixing A cracked or damaged display can significantly affect your Samsung Galaxy's usability and aesthetic appeals. Whether your tool has actually experienced a minor scratch or an extreme fracture, our professional service technicians at Gadget Kings PRS have the understanding and competence to perform accurate screen repairs. We utilize high-grade replacement parts and cutting-edge techniques to recover your Samsung Galaxy's display to its initial condition, enabling you to delight in a clear and lively display screen once more. Battery Repair Is your [https://www.google.com/maps/place/GADGET+KINGS+PRS-(iPhone+:+iPad+:+Samsung+%26+Computer+service)/@-27.2977637,152.6878419,11z/data=!4m10!1m2!2m1!1sgadget+kings+prs!3m6!1s0x6b93e38da2785a61:0x8f2d74581f1028d5!8m2!3d-27.2977637!4d152.976233!15sChBnYWRnZXQga2luZ3MgcHJzkgEYbW9iaWxlX3Bob25lX3JlcGFpcl9zaG9w4AEA!16s%2Fg%2F11fp6plsyf?entry=ttu samsung s7 battery replacement near me] Galaxy struggling to hold a cost or experiencing quick battery drainpipe? At Device Kings PRS, we specialize in diagnosing and fixing battery issues for Samsung Galaxy devices of all designs. Why Select Gadget Kings PRS? Specialist Technicians At Gadget Kings PRS, we take satisfaction in our team of specialist service technicians that have comprehensive experience in repairing Samsung Galaxy devices. Our professionals undertake strenuous training and stay upgraded on the most up to date fixing techniques to provide premium results with every repair. Quality Components We understand the significance of making use of authentic and premium substitute parts for Samsung Galaxy repair work. That's why we source our components from trusted vendors to ensure compatibility and integrity, permitting you to take pleasure in ideal performance and sturdiness from your fixed gadget. Practical Locations and Online Booking With hassle-free places in Bray Park and Acacia Ridge, scheduling your Samsung Galaxy fixing at Gadget Kings PRS fasts and problem-free. In addition, our straightforward online booking system enables you to book your repair service appointment with simplicity, guaranteeing a smooth experience throughout. Experience Superior Fixing Provider at Device Kings PRS Do not allow a damaged screen or a malfunctioning battery impede your Samsung Galaxy experience. Go To Gadget Kings PRS today and leave your gadget to our competent professionals. Whether you possess a Samsung Galaxy S9 And also or the most recent Samsung Galaxy S21 collection, we have the competence to restore your tool and recover its performance. Call us through phone at +61 450753672 or email gadget.kings.prs@gmail.com to schedule your repair work appointment or visit us at Shop no. 20 A Kensington Town Shopping Mall, 8 Sovereigns Ave, Bray Park QLD 4500 or 4/28 Elizabeth St, Acacia Ridge QLD 4110 Brisbane Australia. Count On Gizmo Kings PRS for expert repair services that revive your Samsung Galaxy tool. Is your Samsung Galaxy gadget in demand of display or battery repair? Look no further than Device Kings PRS, where we specialize in giving first-class repair work services for a vast variety of Samsung Galaxy designs. From the Samsung Galaxy S9 And also to the latest Samsung Galaxy S21 collection, our experienced technicians are equipped to deal with all your repair requires, making sure that your gadget functions efficiently as soon as again. Whether your gadget has experienced a minor scrape or a severe crack, our professional professionals at Gadget Kings PRS have the understanding and knowledge to perform exact display repair work. At Gadget Kings PRS, we specialize in diagnosing and repairing battery concerns for Samsung Galaxy devices of all models.

Main Page

2024-05-31T09:48:15Z

Breadbox: Undo revision 9609 by YTZAntonietta (talk)

Revitalize Your Samsung Galaxy: Specialist Display and Battery Fixing Providers Is your Samsung Galaxy gadget seeking display or battery repair work? Look no additional than Gizmo Kings PRS, where we concentrate on giving first-class repair work options for a variety of Samsung Galaxy versions. From the Samsung Galaxy S9 Plus to the most recent Samsung Galaxy S21 series, our knowledgeable technicians are furnished to deal with all your repair work requires, ensuring that your tool features ideally once again. Comprehensive Display and Battery Repair Providers Screen Fixing A split or damaged display can significantly impact your Samsung Galaxy's functionality and visual appeals. Whether your gadget has experienced a small scratch or an extreme fracture, our specialist service technicians at Gadget Kings PRS have the understanding and proficiency to execute specific display repair services. We utilize premium substitute parts and cutting-edge methods to restore your Samsung Galaxy's screen to its original condition, allowing you to take pleasure in a clear and dynamic display screen once more. Battery Repair work Is your Samsung Galaxy having a hard time to hold a fee or experiencing rapid battery drain? A faulty battery can disrupt your gadget's efficiency and restrict its use. At Gadget Kings PRS, we specialize in diagnosing and fixing battery problems for Samsung Galaxy tools of all models. Whether it's a damaged battery or a software-related issue, our specialists will successfully replace your [https://www.google.com/maps/place/Gadget+Kings+PRS+phones+%26+MacBook+services/@-27.5899477,152.7390028,11z/data=!4m10!1m2!2m1!1sgadget+kings+prs!3m6!1s0x6b9147fd3f4b2611:0x31b6ea9951dcb591!8m2!3d-27.5899477!4d153.0273939!15sChBnYWRnZXQga2luZ3MgcHJzkgEYbW9iaWxlX3Bob25lX3JlcGFpcl9zaG9w4AEA!16s%2Fg%2F11mtdhxp08?entry=ttu ipad battery replacement] with a top notch replacement, restoring your tool's battery life and ensuring durable performance. Why Pick Gizmo Kings PRS? Expert Technicians At Gadget Kings PRS, we take pride in our team of expert service technicians that have substantial experience out of commission Samsung Galaxy gadgets. Our professionals go through rigorous training and stay updated on the latest fixing techniques to provide exceptional results with every repair. Top quality Components We understand the significance of utilizing authentic and top notch substitute components for Samsung Galaxy repair services. That's why we source our parts from trusted distributors to ensure compatibility and dependability, allowing you to enjoy optimal performance and sturdiness from your repaired device. Practical Places and Online Booking With practical areas in Bray Park and Acacia Ridge, scheduling your Samsung Galaxy fixing at Gizmo Kings PRS fasts and easy. Additionally, our easy to use online reserving system permits you to book your fixing consultation effortlessly, guaranteeing a seamless experience throughout. Experience Superior Repair Work Provider at Gizmo Kings PRS Do not allow a damaged display or a malfunctioning battery prevent your Samsung Galaxy experience. See Device Kings PRS today and entrust your gadget to our skilled professionals. Whether you own a Samsung Galaxy S9 And also or the newest Samsung Galaxy S21 series, we have the expertise to revitalize your gadget and recover its functionality. Get in touch with us using phone at +61 450753672 or email gadget.kings.prs@gmail.com to book your fixing appointment or see us at Store no. 20 A Kensington Village Shopping Mall, 8 Sovereigns Ave, Bray Park QLD 4500 or 4/28 Elizabeth St, Acacia Ridge QLD 4110 Brisbane Australia. Count On Gizmo Kings PRS for specialist repair services that revive your Samsung Galaxy tool. Is your Samsung Galaxy device in demand of display or battery repair? Look no further than Gizmo Kings PRS, where we specialize in giving first-class repair work services for a broad array of Samsung Galaxy versions. From the Samsung Galaxy S9 Plus to the most current Samsung Galaxy S21 collection, our competent technicians are outfitted to manage all your repair service requires, making sure that your gadget functions ideally when again. Whether your device has actually endured a small scratch or a serious crack, our specialist technicians at Gadget Kings PRS have the knowledge and proficiency to execute specific screen repair services. At Device Kings PRS, we specialize in diagnosing and fixing battery problems for Samsung Galaxy gadgets of all models.

Keyboard Mappings

2024-03-28T09:11:10Z

Breadbox: /* Numeric keypad (number pad, numpad) */

== Symbolic mapping ==

Breadbox uses symbolic mapping of the keys. This means the symbols you type on your computer are linked to the same symbols (or key combination that creates the symbol) on the simulated computer. Some symbols don't exist on the simulated computer. If so, the key is linked to another key, with fuzzy logic, for example look at the below mapping tables of ''function and modifier key mappings''. Another obvious thing is that the simulated computer has symbols that are not on the PC keyboard. In that case, you have the option to zoom in on the keyboard and click the symbol with your mouse pointer.

In short, pressing symbols like '''a, b, 1, 2, !, @, $, ., (, *''' should all give the same/similar output on a simulated computer.

''Some of the function and modifier key mappings are not that obvious and can be different depending on the computer model. Below you will find key mapping tables to help you locate them.''

=== Numeric keypad (number pad, numpad) ===

The numeric keypad has two typing-modes, plus joystick mode.

==== Joystick mode ====

To setup the numpad joystick emulation, go to '''Settings''' -> '''Input Settings''', and under joystick controllers, '''select Numpad'''.

In joystick mode, the number keys (1-8) on the numpad will emulate joystick directions and 0 works as Fire-button.

==== Typing mode ====

Typing-mode is '''on''', when joystick emulation is '''not''' active.

In typing-mode you can change the mode by pressing the '''Numlock''' key. By default, it operates in calculator mode and displays numbers and symbols related to the calculation. In the other mode, it works as an alternative navigation keypad. Then you can use 8,4,6 and 2(or 5) as navigation/arrow keys, in the same way you'd use the normal arrow keys to move the cursor.

== Keyboard layouts ==

There are many different PC keyboard layouts. It means that some of the symbols are different or in different places. To have working symbolic mapping, a correct layout (or a close match) should be selected in Breadbox.

Currently available keyboard layouts are:
* US - American
* UK - British
* DE - German
* DK - Danish
* ES - Spanish
* FR - French
* FI - Finnish
* IT - Italian
* MX - Latin American
* NO - Norwegian
* PT - Portuguese
* SE - Swedish

== Function and modifier key mappings ==

=== C-64 & VIC-20 ===

{| class="wikitable" style="float:left; margin-left: 20px;"
!colspan="2" | Function keys
|-
! style="color:blue; width:130px;" | C-64 / VIC-20
! style="color:black; width:130px;" | PC
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|CLR
|Shift + Home
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|HOME
|Home
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|INST
|Insert
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|DEL
|Delete Backspace
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|RESTORE
|Page Up
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|RUN
|Shift + Escape
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|STOP
|Escape
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|RETURN
|Return Enter
|}

{| class="wikitable" style="float:left; margin-left: 40px;"
!colspan="2" | Modifier keys
|-
! style="color:blue; width:130px;" | C-64 / VIC-20
! style="color:black; width:130px;" | PC
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|CTRL
|Right Control Tab
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|COMMODORE CBM (No-logo-key)
|Left Control
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|SHIFT
|Shift
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|SHIFT LOCK
|Caps Lock
|}

 

=== PET 2001 ===

{| class="wikitable" style="float:left; margin-left: 20px;"
!colspan="2" | Function keys
|-
! style="color:blue; width:130px;" | PET 2001
! style="color:black; width:130px;" | PC
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|CLR
|Shift + Home
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|HOME
|Home
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|INST
|Insert
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|DEL
|Delete Backspace
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|RETURN
|Return Enter
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|OFF
|Shift + Tab
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|RVS
|Tab
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|RUN
|Shift + Escape
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|STOP
|Escape
|}

{| class="wikitable" style="float:left; margin-left: 40px;"
!colspan="2" | Modifier keys
|-
! style="color:blue; width:130px;" | PET 2001
! style="color:black; width:130px;" | PC
|- style="vertical-align:middle; text-align:center; padding: 10px; height:50px;"
|SHIFT
|Shift
|}

FAQ

2024-03-28T08:52:27Z

Breadbox:

FAQ

2024-03-28T08:40:29Z

Breadbox: /* keyboard input lag (The computer doesn't register all my key presses and responses are slow) */

FAQ

2024-03-28T08:38:09Z

Breadbox: /* The computer doesn't register all my key presses and responses are slow e.g. keyboard input lag */

FAQ

2024-03-28T08:31:24Z

Breadbox:

FAQ

2024-03-28T08:31:00Z

Breadbox: /* The computer doesn't register all my key presses and responses are slow */

=== Is Breadbox only a Commodore Simulator? ===

Currently, '''yes''', but the project has ambitions to incorporate additional computers, extending beyond the Commodore brand.

The actual progress of this goal hinges on the level of support it receives. The project’s expansion is contingent upon sufficient funding.

----

=== Computer power-up takes some time ===

When you power on for the first time after installing or updating a new emulator, it may be a little slower. Subsequent startups should be faster.
----

=== Computer does not start (emulator is installed) ===

First, attempt to power off the simulated computer, and then turn it back on. If this doesn’t resolve the issue, '''exit the Simulator view''' and give it another try.

Next, consider '''restarting the Breadbox''' or performing a '''reboot of your PC'''.

''Note! This issue also arises on the Steam Deck. The Steam Deck runs on Linux, which is '''currently not supported'''.''

----

=== Splash screen is blank / computers are not visible in the simulator view ===

Your computer’s '''graphics card''' falls short of the requirements needed to run '''BreadBox'''.

Breadbox will only work on GPUs that support DirectX 11 with Shader Model 5.0 or higher.

----

=== Game Controller doesn't work ===

If your controller is supported, then usually this happens if you plug in your controller when the emulator (the simulated computer) is already running. In that case, restart the simulated computer.

If the problem persists, verify whether your controller is '''connected''' to a virtual joystick. In ''Simulator view'' open '''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''.

If the problem still persists, detach/attach the joystick plug and verify if you need to use a different control port (C64). Sometimes the classic power OFF and ON (simulated computer) might help.

Also, don't forget to check the known issues related to your controller in the [[Manual#Breadbox_Game_Controller_support|Breadbox Game Controller support]] section.

----

=== Simulator view responds slowly to user actions / Animations stutter ===

'''Breadbox''' requires an '''efficient graphics card'''. Please refer to the '''minimum system requirements'''.

Test with different graphics settings and see how it affects the performance. '''Graphics settings''' are accessible on the '''Main page''' within the '''Setup''' panel. Try to '''lower the resolution''', set graphics quality to '''Low''' and decrease the frame rate to 30 FPS.

You can also try removing unused items from the view. For example, the cassette has been reported to cause performance issues with lower-end graphics cards.

----

=== The computer doesn't register all my key presses and responses are slow e.g. keyboard input lag ===

This is also related to graphics card performance and perhaps also to CPU performance. If the graphics card is not efficient enough for Breadbox, it starts to affect other functions.

Lowering the graphics settings, e.g. resolution, may have a big impact. Zooming to monitor close-up view will also help on this issue.

Unfortunately, this problem strongly indicates that your current graphics card and/or CPU performance of your computer is not sufficient for this software.

----

=== Keyboard input lag ===

When using the Breadbox with the ''recommended hardware'', we haven't experienced any serious input lag
that would affect normal use, including gaming. However, it's a fact that there is more delay in input as well
as in output when compared to plain emulator usage.

If you experience input lag when using the Breadbox, it likely belongs to one of the following categories.

====1. Hardware requirements====

:It is known that Breadbox requires high-performance hardware in terms of CPU and GPU. Our tests with various hardware and feedback from users have shown that when the hardware is not sufficient, it significantly affects the input delay.

:You should try to lower graphics quality and screen resolution. Graphics settings are on the setup panel in Breadbox Main Menu.
:If that doesn't help with this issue, check if the problem is related to other categories here.

====2. Audio visual effect delay====

:In Breadbox there is a difference between the input signal sent to the emulator and between audio-visual effects. The audio-visual effect is the sound and animation of the keyboard key press. When the key press of the real keyboard press starts, it is not possible to start the audio-visual effect in real-time, and its execution can be seen and heard quite clearly with a small delay. As human perception is strongly affected by everything we see and hear, this may create a strong experience of an input lag. Despite the fact that the actual input signal is registered and displayed on the virtual monitor much faster than the audio-visual experience from the effects.

:The simple solution is to disable the keyboard sound simulation. It will disable the sounds of key presses from the Breadbox when using the PC keyboard. But the sounds will still work when you use the mouse to click on virtual keys. You can disable the keyboard sounds from each of the computers from the setup panel in the simulator view, just uncheck the option: ''keyboard sound simulation''.

====3. It's a bug====

:There is always the possibility that the problem is caused by a software bug. Please try to analyze how it occurs and if it is still an issue after you restart everything.

:Regardless, please report the problem to us.

====4. Normal input lag====

:If the other three options are not effective, then it must be the normal input lag.

:This means it is just a normal feature of the product. The normal input lag accumulates from the input (the key press) to the output (what you see on the monitor). Relaying signals requires a little extra work from the software. And perhaps it can be further improved in the future.

:In our experience, it isn't affecting normal use, so we consider it a normal feature. But we'll leave the judgment to you, the user. If you experience that the normal input lag is too high, please report it.

----

FAQ

2024-03-27T19:50:39Z

Breadbox: /* Simulator view responds slowly to user actions / Animations stutter */

=== Is Breadbox only a Commodore Simulator? ===

Currently, '''yes''', but the project has ambitions to incorporate additional computers, extending beyond the Commodore brand.

The actual progress of this goal hinges on the level of support it receives. The project’s expansion is contingent upon sufficient funding.

----

=== Computer power-up takes some time ===

When you power on for the first time after installing or updating a new emulator, it may be a little slower. Subsequent startups should be faster.
----

=== Computer does not start (emulator is installed) ===

First, attempt to power off the simulated computer, and then turn it back on. If this doesn’t resolve the issue, '''exit the Simulator view''' and give it another try.

Next, consider '''restarting the Breadbox''' or performing a '''reboot of your PC'''.

''Note! This issue also arises on the Steam Deck. The Steam Deck runs on Linux, which is '''currently not supported'''.''

----

=== Splash screen is blank / computers are not visible in the simulator view ===

Your computer’s '''graphics card''' falls short of the requirements needed to run '''BreadBox'''.

Breadbox will only work on GPUs that support DirectX 11 with Shader Model 5.0 or higher.

----

=== Game Controller doesn't work ===

If your controller is supported, then usually this happens if you plug in your controller when the emulator (the simulated computer) is already running. In that case, restart the simulated computer.

If the problem persists, verify whether your controller is '''connected''' to a virtual joystick. In ''Simulator view'' open '''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''.

If the problem still persists, detach/attach the joystick plug and verify if you need to use a different control port (C64). Sometimes the classic power OFF and ON (simulated computer) might help.

Also, don't forget to check the known issues related to your controller in the [[Manual#Breadbox_Game_Controller_support|Breadbox Game Controller support]] section.

----

=== Simulator view responds slowly to user actions / Animations stutter ===

'''Breadbox''' requires an '''efficient graphics card'''. Please refer to the '''minimum system requirements'''.

Test with different graphics settings and see how it affects the performance. '''Graphics settings''' are accessible on the '''Main page''' within the '''Setup''' panel. Try to '''lower the resolution''', set graphics quality to '''Low''' and decrease the frame rate to 30 FPS.

You can also try removing unused items from the view. For example, the cassette has been reported to cause performance issues with lower-end graphics cards.

----

=== The computer doesn't register all my key presses and responses are slow ===

This is also related to graphics card performance and perhaps also to CPU performance. If the graphics card is not efficient enough for Breadbox, it starts to affect other functions.

Lowering the graphics settings, e.g. resolution, may have a big impact. Zooming to monitor close-up view will also help on this issue.

Unfortunately, this problem strongly indicates that your current graphics card and/or CPU performance of your computer is not sufficient for this software.

----

=== Keyboard input lag ===

When using the Breadbox with the ''recommended hardware'', we haven't experienced any serious input lag
that would affect normal use, including gaming. However, it's a fact that there is more delay in input as well
as in output when compared to plain emulator usage.

If you experience input lag when using the Breadbox, it likely belongs to one of the following categories.

====1. Hardware requirements====

:It is known that Breadbox requires high-performance hardware in terms of CPU and GPU. Our tests with various hardware and feedback from users have shown that when the hardware is not sufficient, it significantly affects the input delay.

:You should try to lower graphics quality and screen resolution. Graphics settings are on the setup panel in Breadbox Main Menu.
:If that doesn't help with this issue, check if the problem is related to other categories here.

====2. Audio visual effect delay====

:In Breadbox there is a difference between the input signal sent to the emulator and between audio-visual effects. The audio-visual effect is the sound and animation of the keyboard key press. When the key press of the real keyboard press starts, it is not possible to start the audio-visual effect in real-time, and its execution can be seen and heard quite clearly with a small delay. As human perception is strongly affected by everything we see and hear, this may create a strong experience of an input lag. Despite the fact that the actual input signal is registered and displayed on the virtual monitor much faster than the audio-visual experience from the effects.

:The simple solution is to disable the keyboard sound simulation. It will disable the sounds of key presses from the Breadbox when using the PC keyboard. But the sounds will still work when you use the mouse to click on virtual keys. You can disable the keyboard sounds from each of the computers from the setup panel in the simulator view, just uncheck the option: ''keyboard sound simulation''.

====3. It's a bug====

:There is always the possibility that the problem is caused by a software bug. Please try to analyze how it occurs and if it is still an issue after you restart everything.

:Regardless, please report the problem to us.

====4. Normal input lag====

:If the other three options are not effective, then it must be the normal input lag.

:This means it is just a normal feature of the product. The normal input lag accumulates from the input (the key press) to the output (what you see on the monitor). Relaying signals requires a little extra work from the software. And perhaps it can be further improved in the future.

:In our experience, it isn't affecting normal use, so we consider it a normal feature. But we'll leave the judgment to you, the user. If you experience that the normal input lag is too high, please report it.

----

FAQ

2024-03-27T18:03:30Z

Breadbox: /* Game Controller doesn't work */

=== Is Breadbox only a Commodore Simulator? ===

Currently, '''yes''', but the project has ambitions to incorporate additional computers, extending beyond the Commodore brand.

The actual progress of this goal hinges on the level of support it receives. The project’s expansion is contingent upon sufficient funding.

----

=== Computer power-up takes some time ===

When you power on for the first time after installing or updating a new emulator, it may be a little slower. Subsequent startups should be faster.
----

=== Computer does not start (emulator is installed) ===

First, attempt to power off the simulated computer, and then turn it back on. If this doesn’t resolve the issue, '''exit the Simulator view''' and give it another try.

Next, consider '''restarting the Breadbox''' or performing a '''reboot of your PC'''.

''Note! This issue also arises on the Steam Deck. The Steam Deck runs on Linux, which is '''currently not supported'''.''

----

=== Splash screen is blank / computers are not visible in the simulator view ===

Your computer’s '''graphics card''' falls short of the requirements needed to run '''BreadBox'''.

Breadbox will only work on GPUs that support DirectX 11 with Shader Model 5.0 or higher.

----

=== Game Controller doesn't work ===

If your controller is supported, then usually this happens if you plug in your controller when the emulator (the simulated computer) is already running. In that case, restart the simulated computer.

If the problem persists, verify whether your controller is '''connected''' to a virtual joystick. In ''Simulator view'' open '''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''.

If the problem still persists, detach/attach the joystick plug and verify if you need to use a different control port (C64). Sometimes the classic power OFF and ON (simulated computer) might help.

Also, don't forget to check the known issues related to your controller in the [[Manual#Breadbox_Game_Controller_support|Breadbox Game Controller support]] section.

----

=== Simulator view responds slowly to user actions / Animations stutter ===

Breadbox requires an efficient graphics card when used with default graphics settings. Likely, your graphics card is not powerful enough for default settings.

Test with different graphics settings and see how it affects the performance. Graphics settings are available on the ''Main menu'' page in the ''Setup'' panel. Try a lower resolution and with graphics quality set to ''Low''.

You can also try removing unused items from the view. For example, the cassette has been reported to cause performance issues with lower-end graphics cards.

----

=== The computer doesn't register all my key presses and responses are slow ===

This is also related to graphics card performance and perhaps also to CPU performance. If the graphics card is not efficient enough for Breadbox, it starts to affect other functions.

Lowering the graphics settings, e.g. resolution, may have a big impact. Zooming to monitor close-up view will also help on this issue.

Unfortunately, this problem strongly indicates that your current graphics card and/or CPU performance of your computer is not sufficient for this software.

----

=== Keyboard input lag ===

When using the Breadbox with the ''recommended hardware'', we haven't experienced any serious input lag
that would affect normal use, including gaming. However, it's a fact that there is more delay in input as well
as in output when compared to plain emulator usage.

If you experience input lag when using the Breadbox, it likely belongs to one of the following categories.

====1. Hardware requirements====

:It is known that Breadbox requires high-performance hardware in terms of CPU and GPU. Our tests with various hardware and feedback from users have shown that when the hardware is not sufficient, it significantly affects the input delay.

:You should try to lower graphics quality and screen resolution. Graphics settings are on the setup panel in Breadbox Main Menu.
:If that doesn't help with this issue, check if the problem is related to other categories here.

====2. Audio visual effect delay====

:In Breadbox there is a difference between the input signal sent to the emulator and between audio-visual effects. The audio-visual effect is the sound and animation of the keyboard key press. When the key press of the real keyboard press starts, it is not possible to start the audio-visual effect in real-time, and its execution can be seen and heard quite clearly with a small delay. As human perception is strongly affected by everything we see and hear, this may create a strong experience of an input lag. Despite the fact that the actual input signal is registered and displayed on the virtual monitor much faster than the audio-visual experience from the effects.

:The simple solution is to disable the keyboard sound simulation. It will disable the sounds of key presses from the Breadbox when using the PC keyboard. But the sounds will still work when you use the mouse to click on virtual keys. You can disable the keyboard sounds from each of the computers from the setup panel in the simulator view, just uncheck the option: ''keyboard sound simulation''.

====3. It's a bug====

:There is always the possibility that the problem is caused by a software bug. Please try to analyze how it occurs and if it is still an issue after you restart everything.

:Regardless, please report the problem to us.

====4. Normal input lag====

:If the other three options are not effective, then it must be the normal input lag.

:This means it is just a normal feature of the product. The normal input lag accumulates from the input (the key press) to the output (what you see on the monitor). Relaying signals requires a little extra work from the software. And perhaps it can be further improved in the future.

:In our experience, it isn't affecting normal use, so we consider it a normal feature. But we'll leave the judgment to you, the user. If you experience that the normal input lag is too high, please report it.

----

FAQ

2024-03-27T18:00:28Z

Breadbox: /* Splash screen is blank / computers are not visible in the simulator view */

=== Is Breadbox only a Commodore Simulator? ===

Currently, '''yes''', but the project has ambitions to incorporate additional computers, extending beyond the Commodore brand.

The actual progress of this goal hinges on the level of support it receives. The project’s expansion is contingent upon sufficient funding.

----

=== Computer power-up takes some time ===

When you power on for the first time after installing or updating a new emulator, it may be a little slower. Subsequent startups should be faster.
----

=== Computer does not start (emulator is installed) ===

First, attempt to power off the simulated computer, and then turn it back on. If this doesn’t resolve the issue, '''exit the Simulator view''' and give it another try.

Next, consider '''restarting the Breadbox''' or performing a '''reboot of your PC'''.

''Note! This issue also arises on the Steam Deck. The Steam Deck runs on Linux, which is '''currently not supported'''.''

----

=== Splash screen is blank / computers are not visible in the simulator view ===

Your computer’s '''graphics card''' falls short of the requirements needed to run '''BreadBox'''.

Breadbox will only work on GPUs that support DirectX 11 with Shader Model 5.0 or higher.

----

=== Game Controller doesn't work ===

If your controller is supported, then usually this happens if you plug in your controller when the emulator (the simulated computer) is already running. In that case, restart the simulated computer.

Then, if the problem continues, check if your controller is linked to a virtual joystick. In ''Simulator view'' open '''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''.

If the problem persists, detach/attach the joystick plug and verify if you need to use a different control port (C64). Sometimes the classic power OFF and ON (simulated computer) might help.

Also, don't forget to check the known issues related to your controller in the [[Manual#Breadbox_Game_Controller_support|Breadbox Game Controller support]] section.

----

=== Simulator view responds slowly to user actions / Animations stutter ===

Breadbox requires an efficient graphics card when used with default graphics settings. Likely, your graphics card is not powerful enough for default settings.

Test with different graphics settings and see how it affects the performance. Graphics settings are available on the ''Main menu'' page in the ''Setup'' panel. Try a lower resolution and with graphics quality set to ''Low''.

You can also try removing unused items from the view. For example, the cassette has been reported to cause performance issues with lower-end graphics cards.

----

=== The computer doesn't register all my key presses and responses are slow ===

This is also related to graphics card performance and perhaps also to CPU performance. If the graphics card is not efficient enough for Breadbox, it starts to affect other functions.

Lowering the graphics settings, e.g. resolution, may have a big impact. Zooming to monitor close-up view will also help on this issue.

Unfortunately, this problem strongly indicates that your current graphics card and/or CPU performance of your computer is not sufficient for this software.

----

=== Keyboard input lag ===

When using the Breadbox with the ''recommended hardware'', we haven't experienced any serious input lag
that would affect normal use, including gaming. However, it's a fact that there is more delay in input as well
as in output when compared to plain emulator usage.

If you experience input lag when using the Breadbox, it likely belongs to one of the following categories.

====1. Hardware requirements====

:It is known that Breadbox requires high-performance hardware in terms of CPU and GPU. Our tests with various hardware and feedback from users have shown that when the hardware is not sufficient, it significantly affects the input delay.

:You should try to lower graphics quality and screen resolution. Graphics settings are on the setup panel in Breadbox Main Menu.
:If that doesn't help with this issue, check if the problem is related to other categories here.

====2. Audio visual effect delay====

:In Breadbox there is a difference between the input signal sent to the emulator and between audio-visual effects. The audio-visual effect is the sound and animation of the keyboard key press. When the key press of the real keyboard press starts, it is not possible to start the audio-visual effect in real-time, and its execution can be seen and heard quite clearly with a small delay. As human perception is strongly affected by everything we see and hear, this may create a strong experience of an input lag. Despite the fact that the actual input signal is registered and displayed on the virtual monitor much faster than the audio-visual experience from the effects.

:The simple solution is to disable the keyboard sound simulation. It will disable the sounds of key presses from the Breadbox when using the PC keyboard. But the sounds will still work when you use the mouse to click on virtual keys. You can disable the keyboard sounds from each of the computers from the setup panel in the simulator view, just uncheck the option: ''keyboard sound simulation''.

====3. It's a bug====

:There is always the possibility that the problem is caused by a software bug. Please try to analyze how it occurs and if it is still an issue after you restart everything.

:Regardless, please report the problem to us.

====4. Normal input lag====

:If the other three options are not effective, then it must be the normal input lag.

:This means it is just a normal feature of the product. The normal input lag accumulates from the input (the key press) to the output (what you see on the monitor). Relaying signals requires a little extra work from the software. And perhaps it can be further improved in the future.

:In our experience, it isn't affecting normal use, so we consider it a normal feature. But we'll leave the judgment to you, the user. If you experience that the normal input lag is too high, please report it.

----

FAQ

2024-03-27T17:58:57Z

Breadbox: /* Computer does not start (emulator is installed) */

=== Is Breadbox only a Commodore Simulator? ===

Currently, '''yes''', but the project has ambitions to incorporate additional computers, extending beyond the Commodore brand.

The actual progress of this goal hinges on the level of support it receives. The project’s expansion is contingent upon sufficient funding.

----

=== Computer power-up takes some time ===

When you power on for the first time after installing or updating a new emulator, it may be a little slower. Subsequent startups should be faster.
----

=== Computer does not start (emulator is installed) ===

First, attempt to power off the simulated computer, and then turn it back on. If this doesn’t resolve the issue, '''exit the Simulator view''' and give it another try.

Next, consider '''restarting the Breadbox''' or performing a '''reboot of your PC'''.

''Note! This issue also arises on the Steam Deck. The Steam Deck runs on Linux, which is '''currently not supported'''.''

----

=== Splash screen is blank / computers are not visible in the simulator view ===

Your computer's graphics card is not sufficient to run BreadBox.

Breadbox will only work on GPUs that support DirectX 11 with Shader Model 5.0 or higher.

----

=== Game Controller doesn't work ===

If your controller is supported, then usually this happens if you plug in your controller when the emulator (the simulated computer) is already running. In that case, restart the simulated computer.

Then, if the problem continues, check if your controller is linked to a virtual joystick. In ''Simulator view'' open '''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''.

If the problem persists, detach/attach the joystick plug and verify if you need to use a different control port (C64). Sometimes the classic power OFF and ON (simulated computer) might help.

Also, don't forget to check the known issues related to your controller in the [[Manual#Breadbox_Game_Controller_support|Breadbox Game Controller support]] section.

----

=== Simulator view responds slowly to user actions / Animations stutter ===

Breadbox requires an efficient graphics card when used with default graphics settings. Likely, your graphics card is not powerful enough for default settings.

Test with different graphics settings and see how it affects the performance. Graphics settings are available on the ''Main menu'' page in the ''Setup'' panel. Try a lower resolution and with graphics quality set to ''Low''.

You can also try removing unused items from the view. For example, the cassette has been reported to cause performance issues with lower-end graphics cards.

----

=== The computer doesn't register all my key presses and responses are slow ===

This is also related to graphics card performance and perhaps also to CPU performance. If the graphics card is not efficient enough for Breadbox, it starts to affect other functions.

Lowering the graphics settings, e.g. resolution, may have a big impact. Zooming to monitor close-up view will also help on this issue.

Unfortunately, this problem strongly indicates that your current graphics card and/or CPU performance of your computer is not sufficient for this software.

----

=== Keyboard input lag ===

When using the Breadbox with the ''recommended hardware'', we haven't experienced any serious input lag
that would affect normal use, including gaming. However, it's a fact that there is more delay in input as well
as in output when compared to plain emulator usage.

If you experience input lag when using the Breadbox, it likely belongs to one of the following categories.

====1. Hardware requirements====

:It is known that Breadbox requires high-performance hardware in terms of CPU and GPU. Our tests with various hardware and feedback from users have shown that when the hardware is not sufficient, it significantly affects the input delay.

:You should try to lower graphics quality and screen resolution. Graphics settings are on the setup panel in Breadbox Main Menu.
:If that doesn't help with this issue, check if the problem is related to other categories here.

====2. Audio visual effect delay====

:In Breadbox there is a difference between the input signal sent to the emulator and between audio-visual effects. The audio-visual effect is the sound and animation of the keyboard key press. When the key press of the real keyboard press starts, it is not possible to start the audio-visual effect in real-time, and its execution can be seen and heard quite clearly with a small delay. As human perception is strongly affected by everything we see and hear, this may create a strong experience of an input lag. Despite the fact that the actual input signal is registered and displayed on the virtual monitor much faster than the audio-visual experience from the effects.

:The simple solution is to disable the keyboard sound simulation. It will disable the sounds of key presses from the Breadbox when using the PC keyboard. But the sounds will still work when you use the mouse to click on virtual keys. You can disable the keyboard sounds from each of the computers from the setup panel in the simulator view, just uncheck the option: ''keyboard sound simulation''.

====3. It's a bug====

:There is always the possibility that the problem is caused by a software bug. Please try to analyze how it occurs and if it is still an issue after you restart everything.

:Regardless, please report the problem to us.

====4. Normal input lag====

:If the other three options are not effective, then it must be the normal input lag.

:This means it is just a normal feature of the product. The normal input lag accumulates from the input (the key press) to the output (what you see on the monitor). Relaying signals requires a little extra work from the software. And perhaps it can be further improved in the future.

:In our experience, it isn't affecting normal use, so we consider it a normal feature. But we'll leave the judgment to you, the user. If you experience that the normal input lag is too high, please report it.

----

FAQ

2024-03-27T17:51:50Z

Breadbox: /* Is Breadbox only a Commodore Simulator? */

=== Is Breadbox only a Commodore Simulator? ===

Currently, '''yes''', but the project has ambitions to incorporate additional computers, extending beyond the Commodore brand.

The actual progress of this goal hinges on the level of support it receives. The project’s expansion is contingent upon sufficient funding.

----

=== Computer power-up takes some time ===

When you power on for the first time after installing or updating a new emulator, it may be a little slower. Subsequent startups should be faster.
----

=== Computer does not start (emulator is installed) ===

Try first to shut down the simulated computer and then switch it back ON. If that doesn't solve the problem, exit the ''Simulator view'' and try again.

The next steps to try are to restart the Breadbox or reboot your PC.

''Note! This symptom occurs also on Steam Deck. Steam Deck uses Linux which is not supported at the moment.''

----

=== Splash screen is blank / computers are not visible in the simulator view ===

Your computer's graphics card is not sufficient to run BreadBox.

Breadbox will only work on GPUs that support DirectX 11 with Shader Model 5.0 or higher.

----

=== Game Controller doesn't work ===

If your controller is supported, then usually this happens if you plug in your controller when the emulator (the simulated computer) is already running. In that case, restart the simulated computer.

Then, if the problem continues, check if your controller is linked to a virtual joystick. In ''Simulator view'' open '''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''.

If the problem persists, detach/attach the joystick plug and verify if you need to use a different control port (C64). Sometimes the classic power OFF and ON (simulated computer) might help.

Also, don't forget to check the known issues related to your controller in the [[Manual#Breadbox_Game_Controller_support|Breadbox Game Controller support]] section.

----

=== Simulator view responds slowly to user actions / Animations stutter ===

Breadbox requires an efficient graphics card when used with default graphics settings. Likely, your graphics card is not powerful enough for default settings.

Test with different graphics settings and see how it affects the performance. Graphics settings are available on the ''Main menu'' page in the ''Setup'' panel. Try a lower resolution and with graphics quality set to ''Low''.

You can also try removing unused items from the view. For example, the cassette has been reported to cause performance issues with lower-end graphics cards.

----

=== The computer doesn't register all my key presses and responses are slow ===

This is also related to graphics card performance and perhaps also to CPU performance. If the graphics card is not efficient enough for Breadbox, it starts to affect other functions.

Lowering the graphics settings, e.g. resolution, may have a big impact. Zooming to monitor close-up view will also help on this issue.

Unfortunately, this problem strongly indicates that your current graphics card and/or CPU performance of your computer is not sufficient for this software.

----

=== Keyboard input lag ===

When using the Breadbox with the ''recommended hardware'', we haven't experienced any serious input lag
that would affect normal use, including gaming. However, it's a fact that there is more delay in input as well
as in output when compared to plain emulator usage.

If you experience input lag when using the Breadbox, it likely belongs to one of the following categories.

====1. Hardware requirements====

:It is known that Breadbox requires high-performance hardware in terms of CPU and GPU. Our tests with various hardware and feedback from users have shown that when the hardware is not sufficient, it significantly affects the input delay.

:You should try to lower graphics quality and screen resolution. Graphics settings are on the setup panel in Breadbox Main Menu.
:If that doesn't help with this issue, check if the problem is related to other categories here.

====2. Audio visual effect delay====

:In Breadbox there is a difference between the input signal sent to the emulator and between audio-visual effects. The audio-visual effect is the sound and animation of the keyboard key press. When the key press of the real keyboard press starts, it is not possible to start the audio-visual effect in real-time, and its execution can be seen and heard quite clearly with a small delay. As human perception is strongly affected by everything we see and hear, this may create a strong experience of an input lag. Despite the fact that the actual input signal is registered and displayed on the virtual monitor much faster than the audio-visual experience from the effects.

:The simple solution is to disable the keyboard sound simulation. It will disable the sounds of key presses from the Breadbox when using the PC keyboard. But the sounds will still work when you use the mouse to click on virtual keys. You can disable the keyboard sounds from each of the computers from the setup panel in the simulator view, just uncheck the option: ''keyboard sound simulation''.

====3. It's a bug====

:There is always the possibility that the problem is caused by a software bug. Please try to analyze how it occurs and if it is still an issue after you restart everything.

:Regardless, please report the problem to us.

====4. Normal input lag====

:If the other three options are not effective, then it must be the normal input lag.

:This means it is just a normal feature of the product. The normal input lag accumulates from the input (the key press) to the output (what you see on the monitor). Relaying signals requires a little extra work from the software. And perhaps it can be further improved in the future.

:In our experience, it isn't affecting normal use, so we consider it a normal feature. But we'll leave the judgment to you, the user. If you experience that the normal input lag is too high, please report it.

----

Manual

2024-03-27T17:34:33Z

Breadbox: /* Technical Issues */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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'''.

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

----

Manual

2024-03-27T17:33:11Z

Breadbox: /* Technical Issues */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 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|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T17:17:07Z

Breadbox:

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T17:11:57Z

Breadbox: /* Game Controllers */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T17:09:14Z

Breadbox: /* Game Controllers */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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. e.g. support@bitfall.fi''
Additionally, if your controller is working and it's not mentioned in the supported game controllers table, please tell us.

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T17:04:16Z

Breadbox: /* Game Controllers */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T17:02:56Z

Breadbox: /* Game Controllers */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T17:00:19Z

Breadbox:

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T16:59:44Z

Breadbox: /* Keyboard Mappings */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T16:56:53Z

Breadbox:

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T16:56:12Z

Breadbox: /* Books */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T15:52:58Z

Breadbox: /* Software */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T14:43:34Z

Breadbox: /* Get Started */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T11:30:39Z

Breadbox: /* Get Started */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''Keyboard mapping'''
:Set the keyboard language region for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T11:29:21Z

Breadbox: /* Get Started */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''Keyboard mapping'''
:Set the keyboard language region for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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.

[[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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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 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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T11:26:46Z

Breadbox: /* Get Started */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''Keyboard mapping'''
:Set the keyboard language region for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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 to different peripherals, the scene contains a few additional hotspots to allow easy access to some important view 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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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 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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T09:48:44Z

Breadbox: /* Get Started */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''Keyboard mapping'''
:Set the keyboard language region for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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 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 to different peripherals, the scene contains a few additional hotspots to allow easy access to some important view 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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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 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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T09:48:03Z

Breadbox: /* Get Started */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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.

:'''Keyboard mapping'''
:Set the keyboard language area setting for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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 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 to different peripherals, the scene contains a few additional hotspots to allow easy access to some important view 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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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 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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T09:45:45Z

Breadbox: /* Get Started */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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 area mappings 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 area setting for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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 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 to different peripherals, the scene contains a few additional hotspots to allow easy access to some important view 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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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 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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T09:16:58Z

Breadbox: /* Get Started */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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 area mappings 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/re-install the emulator.

:'''Keyboard mapping'''
:Set the keyboard language area setting for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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 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 to different peripherals, the scene contains a few additional hotspots to allow easy access to some important view 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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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 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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T09:13:49Z

Breadbox: /* Get Started */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[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. You can also see the specifications of each model by clicking an info icon on 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 area mappings 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/re-install the emulator.

:'''Keyboard mapping'''
:Set the keyboard language area setting for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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 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 to different peripherals, the scene contains a few additional hotspots to allow easy access to some important view 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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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 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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T07:57:58Z

Breadbox: /* Get Started */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[File:Breadbox Main Menu.png|thumb|Main Menu]]

=== Main Menu ===

The Main Menu shows all the computers available.

To initiate the computer simulation, simply click on an image of any computer model. You can also see the specifications of each model by clicking an info icon on the top-right corner of the image.

==== Setup ====

The Main Menu contains also a Setup panel. In the Setup panel, you can configure settings related to graphics, change keyboard language area mappings 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/re-install the emulator.

:'''Keyboard mapping'''
:Set the keyboard language area setting for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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 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 to different peripherals, the scene contains a few additional hotspots to allow easy access to some important view 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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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 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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T07:55:58Z

Breadbox: /* Emulator installer */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[File:Breadbox Main Menu.png|thumb|Main Menu]]

=== Main Menu ===

The Main Menu shows all the computers available.

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

==== Setup ====

The Main Menu contains also a Setup panel. In the Setup panel, you can configure settings related to graphics, change keyboard language area mappings 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/re-install the emulator.

:'''Keyboard mapping'''
:Set the keyboard language area setting for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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 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 to different peripherals, the scene contains a few additional hotspots to allow easy access to some important view 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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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 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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T07:55:33Z

Breadbox: /* Emulator installer */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# Wait about a minute for download and unpack to finish.
# Installation is ready, when you see a text '''VICE IOI is installed''' together with '''OK''' button.
# 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 ==
[[File:Breadbox Main Menu.png|thumb|Main Menu]]

=== Main Menu ===

The Main Menu shows all the computers available.

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

==== Setup ====

The Main Menu contains also a Setup panel. In the Setup panel, you can configure settings related to graphics, change keyboard language area mappings 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/re-install the emulator.

:'''Keyboard mapping'''
:Set the keyboard language area setting for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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 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 to different peripherals, the scene contains a few additional hotspots to allow easy access to some important view 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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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 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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T07:47:23Z

Breadbox: /* Setup Breadbox Library */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# 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.
# 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 ==
[[File:Breadbox Main Menu.png|thumb|Main Menu]]

=== Main Menu ===

The Main Menu shows all the computers available.

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

==== Setup ====

The Main Menu contains also a Setup panel. In the Setup panel, you can configure settings related to graphics, change keyboard language area mappings 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/re-install the emulator.

:'''Keyboard mapping'''
:Set the keyboard language area setting for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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 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 to different peripherals, the scene contains a few additional hotspots to allow easy access to some important view 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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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 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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T07:43:01Z

Breadbox: /* Initial setup tasks */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''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: [https://youtu.be/z0gy-KOw3KQ Breadbox - Simple Set Up Guide].

===== Setup Breadbox Library =====

The 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# 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.
# 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 ==
[[File:Breadbox Main Menu.png|thumb|Main Menu]]

=== Main Menu ===

The Main Menu shows all the computers available.

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

==== Setup ====

The Main Menu contains also a Setup panel. In the Setup panel, you can configure settings related to graphics, change keyboard language area mappings 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/re-install the emulator.

:'''Keyboard mapping'''
:Set the keyboard language area setting for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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 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 to different peripherals, the scene contains a few additional hotspots to allow easy access to some important view 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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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 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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T07:39:55Z

Breadbox: /* Setting Up */

== 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''Start the Breadbox''' and follow the instructions to complete the 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.

A short video tutorial about initial setup tasks is available here: [https://youtu.be/z0gy-KOw3KQ Breadbox - Simple Set Up Guide].

===== Setup Breadbox Library =====

The 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# 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.
# 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 ==
[[File:Breadbox Main Menu.png|thumb|Main Menu]]

=== Main Menu ===

The Main Menu shows all the computers available.

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

==== Setup ====

The Main Menu contains also a Setup panel. In the Setup panel, you can configure settings related to graphics, change keyboard language area mappings 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/re-install the emulator.

:'''Keyboard mapping'''
:Set the keyboard language area setting for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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 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 to different peripherals, the scene contains a few additional hotspots to allow easy access to some important view 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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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 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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T07:38:18Z

Breadbox: /* Setting Up */

== 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).
* '''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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''Start the Breadbox''' and follow the instructions to complete the 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.

A short video tutorial about initial setup tasks is available here: [https://youtu.be/z0gy-KOw3KQ Breadbox - Simple Set Up Guide].

===== Setup Breadbox Library =====

The 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# 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.
# 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 ==
[[File:Breadbox Main Menu.png|thumb|Main Menu]]

=== Main Menu ===

The Main Menu shows all the computers available.

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

==== Setup ====

The Main Menu contains also a Setup panel. In the Setup panel, you can configure settings related to graphics, change keyboard language area mappings 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/re-install the emulator.

:'''Keyboard mapping'''
:Set the keyboard language area setting for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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 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 to different peripherals, the scene contains a few additional hotspots to allow easy access to some important view 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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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 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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

Manual

2024-03-27T07:37:16Z

Breadbox: /* Setting Up */

== 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).
* 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.

# Install '''Steam client''' and create your '''Steam account''' (if you don't already have it).
# '''Purchase''' your personal copy of '''Breadbox''' using Steam client or from the [https://store.steampowered.com/app/1770440/Breadbox/ Steam Store page].
# Open your Steam Library and '''select Breadbox'''.
# Click '''Install''' and wait until the installation is finished.
# '''Start the Breadbox''' and follow the instructions to complete the 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.

A short video tutorial about initial setup tasks is available here: [https://youtu.be/z0gy-KOw3KQ Breadbox - Simple Set Up Guide].

===== Setup Breadbox Library =====

The 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:''
<pre>
..\Breadbox Library
|- c64
| |- books
| |- cart
| |- disk
| |- tape
|- pet
| |- books
| |- ...
|- vic20
| |- books
| |- ...
</pre>

===== 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.''
# Click '''SETUP''' on the Main Page.
# Click '''Setup or Update''' depending on which is available.

==== Emulator installer ====
# 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'''.
# 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.)''
# Click '''Install'''
# 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.
# 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 ==
[[File:Breadbox Main Menu.png|thumb|Main Menu]]

=== Main Menu ===

The Main Menu shows all the computers available.

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

==== Setup ====

The Main Menu contains also a Setup panel. In the Setup panel, you can configure settings related to graphics, change keyboard language area mappings 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/re-install the emulator.

:'''Keyboard mapping'''
:Set the keyboard language area setting for all simulated computers here.

:'''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.

:'''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.

[[File:Breadbox PET 2001 default view.png|thumb|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 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 to different peripherals, the scene contains a few additional hotspots to allow easy access to some important view 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]]
 
''Access the hotspots by hovering the mouse cursor close enough.''

=== Powering Up ===

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 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, 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 ===

[[File:Floppy Disk Library.png|thumb|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 simulator view. Open any library from the left-side navigation icons to see your library 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 have a different cover page, you can replace the generated PNG file with your image file. 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 as well, like in the real computer.

'''Supported 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 can not help in the matter. Presumably, all DirectInput-supported controllers will work well enough. See the table '''Breadbox Game Controller support''' to see the state of current game controller support and known issues.

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

==== 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.

<pre>
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
</pre>

==== Breadbox Game Controller support ====

Current status of Game Controllers tested with Breadbox

:{| class="wikitable"
!|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
|
|- 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 problems are straightforward software bugs and we try to fix those ASAP. However many problems are more complex and require deeper analysis before a 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, 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 the user expects something to work differently than it does.

You can help this software to become better by analyzing 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, see [[FAQ|FAQ]] for some common problems and solutions.

----

About Breadbox

2024-03-27T07:32:06Z

Breadbox:

'''BREADBOX''' is a retro computer simulator program.

Available on [https://store.steampowered.com/app/1770440/Breadbox/ Steam Early Access].

== Objective ==

The Breadbox aims to faithfully recreate the nostalgic experience of retro computers through an immersive visual simulation.

=== Design and development principles ===
* '''Prioritize Aesthetics:''' Highlight the nostalgic charm by faithfully recreating the original design of retro computers and their peripherals.
* '''Immerse the User:''' Craft an immersive first-person experience where users can explore animated objects, interact with authentic hardware, and hear the nostalgic sounds of vintage computing.
* '''Functional Authenticity:''' Ensure fully operational computers within the simulation, seamlessly integrated with emulators for an authentic retro computing.
* '''Realism in Interaction:''' Create a realistic simulation that mirrors real-life interactions, capturing the essence of those early computing days.

While the principles serve as a guideline for the project, further work is needed to add additional features and align some of the current features more closely with these goals.

== Why ==

The '''Breadbox project''' serves as a time capsule, preserving the essence of a bygone era—the days when 8-bit computers ruled the digital landscape. Here’s why this project matters:

# '''Authentic Nostalgia:''' By meticulously simulating the original environment of retro computers, the '''Breadbox''' allows users to step back in time. It’s not just about software or games; it’s about reliving the tactile joy of clunky keyboards, the glow of pixelated screens, and the whir of cassette tape loading. For those who never owned these vintage machines, the '''Breadbox''' offers an authentic glimpse into computing history.
# '''Vanishing Hardware:''' Vintage computers are becoming increasingly scarce. The project’s urgency lies in capturing their essence while we still have access to working hardware and knowledgeable enthusiasts. The '''Breadbox''' provides a chance to utilize machines that might otherwise be inaccessible, preserving the legacy of these devices.
# '''Visual Emphasis:''' The Breadbox prioritizes aesthetics. It’s not just about functionality; it’s about seeing and feeling the past. Whether you’re a curious newcomer or a seasoned enthusiast, the '''Breadbox''' lets you witness the iconic design and visual quirks of retro computers.
# '''Preserving Culture:''' Through the Breadbox, we safeguard the user experiences of retro computers and various peripherals that shaped an entire generation. It’s a tribute to the pioneers who paved the way for today’s digital world.
# '''Hardware-Less Experience:''' When you crave the look and feel of retro hardware but lack the physical machines, the '''Breadbox''' steps in. Using a simulator keeps your real vintage hardware safe from wear and tear.

In summary, the Breadbox project aims to preserve computing memories, inspire curiosity and celebrate the groundbreaking computers that shaped our digital journey.

== The Project ==

The Breadbox project is an ambitious undertaking, and in reality, it will never reach a definitive endpoint. There will always be new computer models, peripherals, software features, and technical details to implement. As a result, the project will evolve dynamically and iteratively, with additional features and models added incrementally. The pace of progress heavily relies on public interest and support.

=== Project status ===
# Early Access Version Development
#* Creating the initial version of the product with limited features.
#* Focusing on core functionality and gathering user feedback.
# Beta Testing
#* Engaging a select group of users to test the product.
#* Identifying and addressing any issues, bugs, or usability concerns
# Release of Early Access Version
#* Making the product available to a broader audience.
#* Monitoring user adoption and collecting additional feedback.
# '''Maturing Product for official release''' <- current state
#* Continuously improving the product based on user feedback.
#* Ensuring stability, scalability, and compatibility.
#* Implementing of additional features.
#* Addressing minor issues, enhancing performance, and refining user experience.
#* Preparing for the official launch.
# Official Release launch
#* Raising awareness
# Post-launch
#* Addressing minor issues, enhancements, and refinements based on user feedback.
#* Introducing new features, expanding capabilities, and adapting to evolving user needs.
#* Determining the subsequent actions based on the product feedback and sales.

=== Simulated Computers ===
:* Commodore PET 2001-8
:* Commodore VIC-20
:* Commodore 64

=== Goals ===

* The goal is to introduce a substantially greater quantity of computers. A successful launch would pave the way for pursuing this goal.

==== Future ====

* '''VR/AR:''' The project already encompasses a significant portion of the technology required for virtual reality creation. When virtual reality (VR) gains wider acceptance and becomes more mainstream, the foundation of the simulator can serve as a solid starting point for developing VR-based solutions.

=== Challenges ===

In summary, developing a retro computer simulator is both challenging and fulfilling. It necessitates resources and backing to keep the project ongoing. With enough support we can continue to develop this product.

==== How to support the project ====

* Purchase the [https://store.steampowered.com/app/1770440/Breadbox/ Breadbox] on Steam Store.
* Go to Steam Store and wishlist the Breadbox.
* Follow on X or on YouTube

== Links ==
* [https://store.steampowered.com/app/1770440/Breadbox/ Breadbox Steam Store page]
* [https://www.youtube.com/channel/UC2nD_faNmYDx2sZvLgEpXWQ Breadbox YouTube Channel]
* [https://twitter.com/BreadboxBitfall Breadbox Twitter/X account]
* [https://www.bitfall.fi Bitfall (Developer)]

About Breadbox

2024-03-27T07:31:36Z

Breadbox: /* Goals */

About Breadbox

2024-03-27T07:18:13Z

Breadbox: /* Why */

'''BREADBOX''' is a retro computer simulator program.

Available on [https://store.steampowered.com/app/1770440/Breadbox/ Steam Early Access].

== Objective ==

The Breadbox aims to faithfully recreate the nostalgic experience of retro computers through an immersive visual simulation.

=== Design and development principles ===
* '''Prioritize Aesthetics:''' Highlight the nostalgic charm by faithfully recreating the original design of retro computers and their peripherals.
* '''Immerse the User:''' Craft an immersive first-person experience where users can explore animated objects, interact with authentic hardware, and hear the nostalgic sounds of vintage computing.
* '''Functional Authenticity:''' Ensure fully operational computers within the simulation, seamlessly integrated with emulators for an authentic retro computing.
* '''Realism in Interaction:''' Create a realistic simulation that mirrors real-life interactions, capturing the essence of those early computing days.

While the principles serve as a guideline for the project, further work is needed to add additional features and align some of the current features more closely with these goals.

== Why ==

The '''Breadbox project''' serves as a time capsule, preserving the essence of a bygone era—the days when 8-bit computers ruled the digital landscape. Here’s why this project matters:

# '''Authentic Nostalgia:''' By meticulously simulating the original environment of retro computers, the '''Breadbox''' allows users to step back in time. It’s not just about software or games; it’s about reliving the tactile joy of clunky keyboards, the glow of pixelated screens, and the whir of cassette tape loading. For those who never owned these vintage machines, the '''Breadbox''' offers an authentic glimpse into computing history.
# '''Vanishing Hardware:''' Vintage computers are becoming increasingly scarce. The project’s urgency lies in capturing their essence while we still have access to working hardware and knowledgeable enthusiasts. The '''Breadbox''' provides a chance to utilize machines that might otherwise be inaccessible, preserving the legacy of these devices.
# '''Visual Emphasis:''' The Breadbox prioritizes aesthetics. It’s not just about functionality; it’s about seeing and feeling the past. Whether you’re a curious newcomer or a seasoned enthusiast, the '''Breadbox''' lets you witness the iconic design and visual quirks of retro computers.
# '''Preserving Culture:''' Through the Breadbox, we safeguard the user experiences of retro computers and various peripherals that shaped an entire generation. It’s a tribute to the pioneers who paved the way for today’s digital world.
# '''Hardware-Less Experience:''' When you crave the look and feel of retro hardware but lack the physical machines, the '''Breadbox''' steps in. Using a simulator keeps your real vintage hardware safe from wear and tear.

In summary, the Breadbox project aims to preserve computing memories, inspire curiosity and celebrate the groundbreaking computers that shaped our digital journey.

== The Project ==

The Breadbox project is an ambitious undertaking, and in reality, it will never reach a definitive endpoint. There will always be new computer models, peripherals, software features, and technical details to implement. As a result, the project will evolve dynamically and iteratively, with additional features and models added incrementally. The pace of progress heavily relies on public interest and support.

=== Project status ===
# Early Access Version Development
#* Creating the initial version of the product with limited features.
#* Focusing on core functionality and gathering user feedback.
# Beta Testing
#* Engaging a select group of users to test the product.
#* Identifying and addressing any issues, bugs, or usability concerns
# Release of Early Access Version
#* Making the product available to a broader audience.
#* Monitoring user adoption and collecting additional feedback.
# '''Maturing Product for official release''' <- current state
#* Continuously improving the product based on user feedback.
#* Ensuring stability, scalability, and compatibility.
#* Implementing of additional features.
#* Addressing minor issues, enhancing performance, and refining user experience.
#* Preparing for the official launch.
# Official Release launch
#* Raising awareness
# Post-launch
#* Addressing minor issues, enhancements, and refinements based on user feedback.
#* Introducing new features, expanding capabilities, and adapting to evolving user needs.
#* Determining the subsequent actions based on the product feedback and sales.

=== Simulated Computers ===
:* Commodore PET 2001-8
:* Commodore VIC-20
:* Commodore 64

=== Goals ===

* Primary aim has been to incorporate a significantly larger number of computers. A successful launch would pave the way for achieving this goal.

==== Future ====

* '''VR/AR:''' The implementation of virtual reality (VR) primarily leverages the existing technology within the project. When virtual reality (VR) gains wider acceptance and becomes more mainstream, the foundation of the simulator can serve as a solid starting point for developing VR-based solutions.

=== Challenges ===

In summary, developing a retro computer simulator is both challenging and fulfilling. It necessitates resources and backing to keep the project ongoing. With enough support we can continue to develop this product.

==== How to support the project ====

* Purchase the [https://store.steampowered.com/app/1770440/Breadbox/ Breadbox] on Steam Store.
* Go to Steam Store and wishlist the Breadbox.
* Follow on X or on YouTube

== Links ==
* [https://store.steampowered.com/app/1770440/Breadbox/ Breadbox Steam Store page]
* [https://www.youtube.com/channel/UC2nD_faNmYDx2sZvLgEpXWQ Breadbox YouTube Channel]
* [https://twitter.com/BreadboxBitfall Breadbox Twitter/X account]
* [https://www.bitfall.fi Bitfall (Developer)]

About Breadbox

2024-03-26T17:58:55Z

Breadbox:

'''BREADBOX''' is a retro computer simulator program.

Available on [https://store.steampowered.com/app/1770440/Breadbox/ Steam Early Access].

== Objective ==

The Breadbox aims to faithfully recreate the nostalgic experience of retro computers through an immersive visual simulation.

=== Design and development principles ===
* '''Prioritize Aesthetics:''' Highlight the nostalgic charm by faithfully recreating the original design of retro computers and their peripherals.
* '''Immerse the User:''' Craft an immersive first-person experience where users can explore animated objects, interact with authentic hardware, and hear the nostalgic sounds of vintage computing.
* '''Functional Authenticity:''' Ensure fully operational computers within the simulation, seamlessly integrated with emulators for an authentic retro computing.
* '''Realism in Interaction:''' Create a realistic simulation that mirrors real-life interactions, capturing the essence of those early computing days.

While the principles serve as a guideline for the project, further work is needed to add additional features and align some of the current features more closely with these goals.

== Why ==

The '''Breadbox project''' serves as a time capsule, preserving the essence of a bygone era—the days when 8-bit computers ruled the digital landscape. Here’s why this project matters:

# '''Authentic Nostalgia:''' By meticulously simulating the original environment of retro computers, the '''Breadbox''' allows users to step back in time. It’s not just about software or games; it’s about reliving the tactile joy of clunky keyboards, the glow of pixelated screens, and the whir of cassette tape loading. For those who never owned these vintage machines, the '''Breadbox''' offers an authentic glimpse into computing history.
# '''Vanishing Hardware:''' Vintage computers are becoming increasingly scarce. The project’s urgency lies in capturing their essence while we still have access to working hardware and knowledgeable enthusiasts. The '''Breadbox''' bridges the gap between past and present, ensuring that the legacy of these machines lives on.
# '''Visual Emphasis:''' The Breadbox prioritizes aesthetics. It’s not just about functionality; it’s about seeing and feeling the past. Whether you’re a curious newcomer or a seasoned enthusiast, the '''Breadbox''' lets you witness the iconic design and visual quirks of retro computers.
# '''Preserving Culture:''' Through the Breadbox, we safeguard the user experiences of retro computers and various peripherals that shaped an entire generation. It’s a tribute to the pioneers who paved the way for today’s digital world.
# '''Hardware Protection:''' Using a simulator or emulator keeps your real vintage hardware safe from wear and tear. No need to risk those delicate components.
# '''Hardware-Less Experience:''' When you crave the look and feel of retro hardware but lack the physical machines, the '''Breadbox''' steps in. It’s nostalgia without clutter, or need for physical shelf space.

In summary, the Breadbox project aims to preserve computing memories, inspire curiosity and celebrate the groundbreaking computers that shaped our digital journey.

== The Project ==

The Breadbox project is an ambitious undertaking, and in reality, it will never reach a definitive endpoint. There will always be new computer models, peripherals, software features, and technical details to implement. As a result, the project will evolve dynamically and iteratively, with additional features and models added incrementally. The pace of progress heavily relies on public interest and support.

=== Project status ===
# Early Access Version Development
#* Creating the initial version of the product with limited features.
#* Focusing on core functionality and gathering user feedback.
# Beta Testing
#* Engaging a select group of users to test the product.
#* Identifying and addressing any issues, bugs, or usability concerns
# Release of Early Access Version
#* Making the product available to a broader audience.
#* Monitoring user adoption and collecting additional feedback.
# '''Maturing Product for official release''' <- current state
#* Continuously improving the product based on user feedback.
#* Ensuring stability, scalability, and compatibility.
#* Implementing of additional features.
#* Addressing minor issues, enhancing performance, and refining user experience.
#* Preparing for the official launch.
# Official Release launch
#* Raising awareness
# Post-launch
#* Addressing minor issues, enhancements, and refinements based on user feedback.
#* Introducing new features, expanding capabilities, and adapting to evolving user needs.
#* Determining the subsequent actions based on the product feedback and sales.

=== Simulated Computers ===
:* Commodore PET 2001-8
:* Commodore VIC-20
:* Commodore 64

=== Goals ===

* Primary aim has been to incorporate a significantly larger number of computers. A successful launch would pave the way for achieving this goal.

==== Future ====

* '''VR/AR:''' The implementation of virtual reality (VR) primarily leverages the existing technology within the project. When virtual reality (VR) gains wider acceptance and becomes more mainstream, the foundation of the simulator can serve as a solid starting point for developing VR-based solutions.

=== Challenges ===

In summary, developing a retro computer simulator is both challenging and fulfilling. It necessitates resources and backing to keep the project ongoing. With enough support we can continue to develop this product.

==== How to support the project ====

* Purchase the [https://store.steampowered.com/app/1770440/Breadbox/ Breadbox] on Steam Store.
* Go to Steam Store and wishlist the Breadbox.
* Follow on X or on YouTube

== Links ==
* [https://store.steampowered.com/app/1770440/Breadbox/ Breadbox Steam Store page]
* [https://www.youtube.com/channel/UC2nD_faNmYDx2sZvLgEpXWQ Breadbox YouTube Channel]
* [https://twitter.com/BreadboxBitfall Breadbox Twitter/X account]
* [https://www.bitfall.fi Bitfall (Developer)]