Vecx JG
-------
Vecx JG is an emulator for the Vectrex.

This is a fork of the original, unmodified vecx sources made available by
Valavan Manohararajah at http://www.valavan.net/vectrex.html

Many new features have been added since the fork was created. The emulator now
contains a new renderer, save states, and support for PSG and DAC based audio.

This repository lives at https://gitlab.com/jgemu/vecx

Compiling
---------
Make sure you have The Jolly Good API's header files installed. If you did
not install them, you will be required to include their path in CFLAGS.

Options:
  DISABLE_MODULE - Set to a non-zero value to disable building the module.
  ENABLE_STATIC_JG - Set to a non-zero value to build a static JG archive.
  USE_VENDORED_SPEEXDSP - Set to a non-zero value to use vendored SpeexDSP.

Linux:
  make

macOS:
  make

BSD:
  gmake

Windows (MSYS2):
  make

Cross Compile:
(For example compiling on Linux for MinGW)
  AR=x86_64-w64-mingw32-ar \
  CC=x86_64-w64-mingw32-cc \
  PKG_CONFIG=x86_64-w64-mingw32-pkg-config \
  STRIP=x86_64-w64-mingw32-strip \
  make

The build will be output to "vecx/". This directory may be used as is
locally by copying it to your local "cores" directory, or may be installed
system-wide using the "install" target specified in the Makefile.

Input Devices
-------------
Vecx JG currently supports the following input devices:

Vectrex Control Pad

Settings
--------
linealgo = 0
0 = Bresenham, 1 = Wu

vscale = 3
N = Internal Video Scale

Auxiliary Files
---------------
Non-standard BIOS images may be selected as auxiliary files.

Copyright
---------
Vecx JG
  Copyright (c) 2002 Valavan Manohararajah (MIT)
  Copyright (c) 2020-2024 Rupert Carmichael (MIT)
  See LICENSE

Speex Resampler
  Copyright (c) 2003, 2007, 2008 Xiph.org Foundation (BSD-3-Clause)
  See source files in deps/speex/ for detailed information

Since there was no license included with the original sources, email
correspondence with the author was initiated, and it was determined that
the sources are "public domain, but cite the source". The MIT License was
chosen, as it roughly fits these requirements.
