summaryrefslogtreecommitdiffstats
path: root/games/ovcc/ovcc.rst
blob: e1b95bc14fb8eedad70b51586e09ba37897529a2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
.. RST source for ovcc(1) man page. Convert with:
..   rst2man.py ovcc.rst > ovcc.6

.. |version| replace:: 1.6.0+20230510_f6c395c
.. |date| date::

====
ovcc
====

----------------------
TRS-80 CoCo 3 emulator
----------------------

:Manual section: 6
:Manual group: SlackBuilds.org
:Date: |date|
:Version: |version|

SYNOPSIS
========

**ovcc** [*quickload-file*]

DESCRIPTION
===========

**ovcc** is "the portable and open Virtual Color Computer", an emulator
for the TRS-80 Color Computer 3.

This man page documents **ovcc** as packaged by SlackBuilds.org.

[*quickload-file*] can be a cartridge ROM image (**\*.rom** or **\*.ccc**)
or a binary executable (**\*.bin**). If the file exists, it will be
loaded into the emulator at startup and executed. The filename
extensions are required, although they are case-insensitive.

There are no other command-line options.

KEYBOARD
========

The keyboard is laid out like the CoCo 3, meaning that e.g. the
double-quote is *Shift-2*.

While **ovcc** is running, press *F12* for a list of keyboard commands.

DISK IMAGES
===========

To use a disk image (**\*.dsk**), first connect the floppy drive:
select *Cartridge* -> *Load Cart* -> **libfd502.so**. After doing
this, the *Cartridge* menu will now have entries for 4 drives. Select
*FD-502 Drive 0* -> *Insert*, then use the file selector to navigate
to the disk image. If necessary, you can choose *File* -> *Hard Reset*
or press *F9* to reboot the Coco 3.

Note that it's easier to move or symlink the disk images into the
**~/.ovcc** directory, since this is the default location for the file
selector.

All the inserted media are remembered in the config file, so when
you exit and re-run **ovcc**, the devices and disks will still be
connected and loaded.

FILES
=====

/usr/games/ovcc
  Shell script wrapper, which sets up the per-user working directory if
  needed, **chdir**\s to it, and executes the real executable.

/usr/libexec/ovcc/ovcc
  The actual executable. Normally you don't want to call this directly.
  Since **ovcc** was ported from Windows, it expects to find its config
  files, ROMs, and loadable modules in the directory it was launched from.

~/.ovcc
  Per-user working directory for **ovcc**. If this dir doesn't exist, the
  **ovcc** wrapper script will create it. Contents:

  Vcc.ini
    The config file. Human-readable and (if you're careful), editable. However,
    the primary way to change the settings here is to use the graphical user
    interface. Any changes made there will be written to this file.

  Vcc.ini_bck
    Backup of the config file, created whenever **ovcc** is about to overwrite the
    config.

  lib\*.so
    Loadable modules which emulate various hardware that can be attached to the
    CoCo 3. In the GUI, you load these from the Cartridge menu. The standard
    floppy disk module is **libfd502.so**. These are symlinks to the real files
    in the package.

    For a description of each emulated device, see:

    https://raw.githubusercontent.com/VCCE/VCC/main/README.md

  \*.rom
    ROM images.

    **coco3.rom** is automatically loaded when the emulator starts up.

    **disk11.rom** is loaded when the **libfd502.so** module is loaded.

    Other modules may require other ROM images (not included in the SBo package).

COPYRIGHT
=========

See the file /usr/doc/ovcc-|version|/README.md for license information.

AUTHORS
=======

ovcc was ported from the original VCC by Joseph Forgione.

VCC was written by the VCC Developement Team.

This man page written for the SlackBuilds.org project
by B. Watson, and is licensed under the WTFPL.

SEE ALSO
========

The ovcc homepage: https://github.com/WallyZambotti/OVCC

The original (Windows-only) VCC homepage: https://github.com/VCCE/VCC/

The TRS-80 Color Computer Archive, which has lots of software for TRS-80
CoCo machines, including the CoCo 3:

https://colorcomputerarchive.com/

**xroar**\(6), which can emulate the Color Computer 2.