--------------------------------------------------------------------------------
kindred v1.12 Preview Build 2
Video Game System Emulator
Copyright (C) 1998-2020 Kris Bleakley
email: kindred@crazysmart.net.au
--------------------------------------------------------------------------------
Last Updated 10th October 2020
Table of Contents
i. Disclaimer
1. Introduction
2. System Requirements
3. Getting Started
3.1 config.ini
4. Preferences
4.1 Hotkeys
4.2 Virtual Devices
5. Famicom Disk System
6. Game Boy
7. Enhancement Chips
8. Special Thanks
9. Copyrights
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
i. Disclaimer (Please read before operating software)
This product is provided free of charge and therefore on an "AS IS" basis,
without warranty of any kind, express or implied, including without limitation
the warranties that it is free of defects, virus free, able to operate on an
uninterrupted basis, merchantable, fit for a particular purpose or
non-infringing. This Disclaimer of warranty constitutes an essential part of
this agreement. No use of the product is authorised hereunder except under this
disclaimer. This product is for non-commercial use only and shall not be
packaged with any commercially licensed product or software.
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
1. Introduction
kindred is an emulator designed to aid in the development of software intended
for use on a home video computer. While a number of years have been spent
perfecting the software, it is not guaranteed to be 100% accurate. kindred was
released under the name Super Sleuth prior to version 1.05. The version in which
features were added/revised is indicated in brackets. See release.txt for more
specific information.
Features include:
* Screen Capture in PNG and BMP format
* Code Inspector and single-step logging options
* PCB database with more than 4150 entries
* CPU cores are relevant at the microcode level or greater.
* Cycle accurate Save States [v1.09]
* Directdraw/Direct3D/OpenGL rendering options [v1.11]
* Custom streaming audio driver [v1.11]
Super Nintendo (*.sfc)
----------------------
[Super Sleuth v1.00]
* Cycle accurate CPU/DMA/SA-1 CPU [v1.09]
* Cycle accurate SMP/DSP [v1.07]
* SPPU1/SPPU2 line-per-line render
* 128KB Backup RAM support
(Support for various backup formats)
* Support for various ROM formats
Super Magicom/Wildcard (Max 64Mbit)
Game Doctor Mode (Max 96Mbit)
* Support for Standard Controller,
Nintendo Scope and Mouse,
NTT Controller [v1.09]
* Super-FX
* Low-level coprocessor support
OBC1, DSP-1 [v1.04], DSP-2 [v1.04], DSP-3 [v1.04], CX4 [v1.04],
SETA-DSP [v1.04], RTC-4513 [v1.09], S-RTC [v1.09]
* Satellaview
* Complete BS Flash Memory Functions [v1.09]
(including lock bits, erase counters and undocumented commands)
* SPC7110 [v1.09] and S-DD1 decompression chips
Nintendo Entertainment System (*.nes)
-------------------------------------
[Super Sleuth v1.00]
* Cycle accurate APU/CPU/PPU
* Support for various Cartridge Types (including C*ROM, U*ROM, B*ROM, A*ROM, G*ROM,
S*ROM, P*ROM, T*ROM, F*ROM, H*ROM)
* Support for Standard Controller,
NTT Controller, TV-NET controller [v1.10]
* NINA Header support [v1.05]
* Tatio TC0690 [v1.06]
* Famicom Basic Keyboard [v1.06]
* Low-Level Famicom Disk operations [v1.06]
* Bandai DATACH [v1.06]
* Famicom Data Recorder [v1.07]
* TV-NET [v1.10]
Nintendo Game Boy (*.gb)
------------------------
[kindred v1.07]
* Cycle accurate CPU
* Support for Mappers
MBC1, MBC2, MBC3, MBC5, MMMO1 (accurate), HUC1, HUC3, TAMA5, Pocket Camera
Sega Master System (*.sms)
--------------------------
[kindred v1.08]
* Cycle accurate CPU/VDP
* SEGA and Codemasters Memory Mapping
* Support for Standard Controllers
IBM PC XT
---------
[kindred v1.10]
* CPU/DMA/PIC/PIT/PPI
* Up to 640K RAM
* Multi-format dual floppy drive
* MDA, CGA, EGA and VGA video
* XT-IDE allows for dual IDE hard drives (optional)
* Full 83 Key XT keyboard
* Microsoft Compatible Serial Mouse on COM1
* PC-Speaker (accurate)
* Sound Blaster DSP [v1.12]
IBM PC AT
---------
[kindred v1.11]
* CPU/DMA/PIC/PIT/RTC/Keyboard controller
* Up to 5MB RAM
* Multi-format dual floppy drive
* MDA, CGA, EGA and VGA video
* Dual IDE hard drives
* Full 84 Key AT Keyboard
* Microsoft Compatible Serial Mouse on COM1
* PC-Speaker (accurate)
* Sound Blaster DSP [v1.12]
Pocket Challenge W (*.pcw)
--------------------------
[kindred v1.12]
* Cycle accurate CPU
* Support for some multi-pack cartridges
* Programmable Pulse Generator
* Support for LCD row/column drivers
* LCD icons
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
2.1 Release Dates
2020-10- kindred v1.12 Preview Build 2
2019-11-11 kindred v1.12 Preview Build 1
2019-09-18 kindred v1.11 Preview Build 6
2019-04-23 kindred v1.11 Preview Build 5
2019-04-07 kindred v1.11 Preview Build 4
2019-01-30 kindred v1.11 Preview Build 3
2018-08-28 kindred v1.11 Preview Build 2
2018-05-28 kindred v1.11 Preview Build 1
2017-12-24 kindred v1.10 Preview Build 1
2017-01-23 kindred v1.09 Preview Build 2
2016-12-17 kindred v1.09 Preview Build 1
2016-03-08 kindred v1.08 Preview Build 1
2015-10-02 kindred v1.07 Preview Build 3
2015-05-29 kindred v1.07 Preview Build 2
2015-05-16 kindred v1.07 Preview Build 1
2014-08-12 kindred v1.06 Preview Build 1
2013-08-31 kindred v1.05 Preview Build 2
2013-08-27 kindred v1.05 Preview Build 1
2011-09-29 Super Sleuth v1.04 Preview Build 7
2008-08-03 Super Sleuth v1.04 Preview Build 6
2006-02-28 Super Sleuth v1.04 Preview Build 5
2005-11-26 Super Sleuth v1.04 Preview Build 4
2005-09-11 Super Sleuth v1.04 Preview Build 3
2005-04-01 Super Sleuth v1.03
2004-12-24 Super Sleuth v1.02
2004-10-04 Super Sleuth v1.01
2004-09-22 Super Sleuth v1.00
1998-08-08 Project started (SPX)
Prior to the first public release the emulator was known as SPX and was only
shared with emulator developers.
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
2. System Requirements
It is recommended that you limit the number of programs running in the background
as this software uses a lot of CPU time while running.
Minimum System Required
* Intel Core 2 Duo 2.4GHz or equivalent processor
* 64MB Available System Memory
* 20MB Available HDD space
* Microsoft Compatible Mouse and Keyboard
* Microsoft Windows 7
* Microsoft Direct-X 8
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
3. Getting Started
kindred has been designed to be as user friendly as humanly possible, while
retaining its purpose as a powerful development tool. To take advantage
of a number of key development systems there are a few important details you
will need to know before operating the software. For this software to be of any
use, you will need ROM files. Under no circumstances will any ROM files be
packaged with this software unless specified in this readme file.
It is recommended that you run kindred from a harddisk drive rather than
from a read-only media such as a CD-ROM. On startup the in-built debug system
will create a trace log file in the startup directory of the software. Failure
to create this log file will result in the debugger not being able to trace CPU
instructions. Also be aware that continual tracing of the system CPU will
eventuate in the trace log growing rapidly in size.
Loading a ROM file is simple, just select open from the file menu. A list of
recently loaded (re-open) files is also available from the file menu.
Alternatively, ROM files may also be loaded by dropping a file from windows
explorer onto the main window. If for any reason a ROM file does not load
correctly try converting the file using a conversion tool (various conversion
tools are available for download from the internet).
Each time a ROM file is loaded information about the ROM will be available on
the Properties window. Information will also be written to the terminal window
as well as the trace log (if tracing is available).
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
3.1 config.ini
Each emulation core has a config.ini file. This file is accessed each time the
emulator is started and can contain any number of sections recognised by the
emulator. All config files may contain a "system" section with the following
global variables recognised by kindred:
window_size
sets the size of the main window
(0=320x200, 1=320x240, 2=640x400, 3=640x480, 4=720x540, 5=800x600, 6=1024x768)
auto_resize
sets the size of the main window to that of the output window.
(0=disable, 1=enable)
aspect_ratio
sets the aspect ratio of the output window
(0=1:1, 1=4:3, 2=16:9)
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
4. Preferences
The following options are available on the Preferences window which is accessible
from the System Menu.
- Enable Hotkeys
Checking this option will enable hotkeys. Unchecking will disable hotkeys.
- Show Database Name in Title Bar
Checking this option will display the database name in the title bar of the main
window. If no database entry exists the name will not be shown.
- Run in Background
Checking this option will allow emulation to continue running if the main window
loses focus. Unchecking will pause emulation if the main window loses focus.
- Enable Soft Patching
Checking this option will enable software patching of ROM images (if a patch is
found) by the loader. Unchecking will disable software patching.
- Restore Session on Startup:
Checking this option will save the current session when kindred is closed and
restore the session immediately the next time kindred is started.
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
4.1 Hotkeys
The following hotkey functions are pre-defined. These can be re-assigned in the
hotkey editor.
Pause Pause
Aspect Ratio Ctrl+Tab
Reset Ctrl+Del
Screen Capture F12
Enter Fullscreen Alt+Enter
Exit Fullscreen Shift+Esc
Toggle Frame Limiter Ctrl+Z
Quick Save 1 Shift+F1
Quick Load 1 Ctrl+F1
Quick Save 2 Shift+F2
Quick Load 2 Ctrl+F2
Quick Save 3 Shift+F3
Quick Load 3 Ctrl+F3
Quick Save 4 Shift+F4
Quick Load 4 Ctrl+F4
If the mouse cursor has been hidden, actioning "Exit Fullscreen" will unhide the
mouse cursor.
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
4.2 Virtual Devices
Once emulation has begun, the Virtual Devices tab will be selectable via the
Preferences window. Input devices supported by the system under emulation can be
redefined here. Double click an action to change the key mapping. The capture
button is used to detect joystick button presses.
Pre-defined Keys
Famicom Keyboard (keyboard.map)
Backspace Stop
Del Delete
PgUp Grph
PgDn Kana
~ @
Famicom Disk System
1 Insert Disk 1 (side A)
2 Insert Disk 1 (side B)
3 Insert Disk 2 (side A)
4 Insert Disk 2 (side B)
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
5. Famicom Disk System
Famicom Disk software will not work without the required RAM Adapter (2C33)
internal ROM. The "rom" variable under the "FDS" section in the NES config.ini
file is used to specify the location of the ROM file.
The disk system should be operated in NTSC mode, otherwise disk errors may occur.
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
6. Game Boy
Nintendo Game Boy software may not operate properly without the Gameboy's internal
boot ROM. The location of the ROM can be specified in the DMG config.ini file.
The included custom boot rom does not guarantee operation on a real system.
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
7. Enhancement Chips
While an effort has been made to add support for enhancement chips, not all chips
are fully supported.
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
8. Special Thanks
In no particular order I would like to thank the following people for their help
and contributions to the emulation scene.
Y0shi, Gary Henderson, Jerremy Koot, zsknight, _Demo_, Eric Pearson, Rob Bohms,
Charles Bilyue', Brad Jorsch, Cowering, Nach, Andreas Naive, John Weidman,
Kevin Mantey, Evan Gowan, Byuu, Shay Green, bootgod
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
9. Copyrights
"Microsoft Windows" is a trademark of Microsoft Corporation.
"Nintendo Entertainment System", "Famicom", "Super Nintendo Entertainment System",
"Super NES", and "Super Famicom" are trademarks of Nintendo Co.,Ltd.
"Super Wildcard" is a trademark of Front Fareast Industrial Corporation.
"Game Doctor" is a trademark of Bung Enterprises.
http://www.crazysmart.net.au/kindred/readme.html