OSDN Git Service

[VM][DEVICE][WIP] Updating State functions.Still cause FTBFS.
[csp-qt/common_source_project-fm7.git] / source / readme.txt
index d62d31a..0f61070 100644 (file)
@@ -1,13 +1,14 @@
-retro pc emulator common source code
-                                                               2/9/2017
+Binary archive of retro pc emulator common source code
+                                                               9/30/2018                                                               
 
 --- What's this ?
 
-This archive includes the all source codes of emulators listed below:
+This archive includes the binaries of the emulators listed below:
 
        ASCII
-               yaMSX1          MSX1 (by Mr.tanam and Mr.umaiboux)
-               yaMSX2          MSX2 (by Mr.tanam and Mr.umaiboux)
+               yayaMSX1        MSX1 (by Mr.tanam and Mr.umaiboux)
+               yayaMSX2        MSX2 (by Mr.tanam and Mr.umaiboux)
+               yayaMSX2+       MSX2+ (by Mr.umaiboux)
        BANDAI
                eRX-78          RX-78
        CANON
@@ -30,9 +31,11 @@ This archive includes the all source codes of emulators listed below:
                eFM8            FM-8 (by Mr.Artane.)
                eFM7            FM-7 (by Mr.Artane.)
                eFM77           FM-77 (by Mr.Artane.)
+               eFM77L4         FM-77L4 (by Mr.Artane.)
                eFM77AV         FM77AV (by Mr.Artane.)
                eFM77AV40       FM77AV40 (by Mr.Artane.)
                eFM77AV40EX     FM77AV40EX (by Mr.Artane.)
+               eFM16beta       FM16beta
                eFM16pi         FM16pi
                eFMR-30         FMR-30
                eFMR-50         FMR-50
@@ -51,8 +54,10 @@ This archive includes the all source codes of emulators listed below:
                eMYCOMZ-80A     MYCOMZ-80A
        MITSUBISHI Electric
                EmuLTI8         MULTI8
-       National
+       National/Panasonic
+               yayaFS-A1       FS-A1 (by Mr.umaiboux)
                eJR-100         JR-100
+               eJR-800         JR-800
        NEC
                ePC-2001        PC-2001
                yaPC-6001       PC-6001 (by Mr.tanam)
@@ -68,13 +73,17 @@ This archive includes the all source codes of emulators listed below:
                ePC-9801U       PC-9801U
                ePC-9801VF      PC-9801VF
                ePC-9801VM      PC-9801VM
+               ePC-9801VX      PC-9801VX
+               ePC-9801RA      PC-9801RA
+               ePC-98XA        PC-98XA
+               ePC-98XL        PC-98XL
+               ePC-98RL        PC-98RL
                ePC-98DO        PC-98DO
                ePC-98LT        PC-98LT
                eHANDY98        PC-98HA
                ePC-100         PC-100
                eTK-80BS        TK-80BS / COMPO BS/80
                eTK-85          TK-85
-               eN5200          N5200 (work in progress)
        NEC-HE
                ePCEngine       PC Engine / SuperGrafx + CD-ROM^2
        Nintendo
@@ -104,12 +113,11 @@ This archive includes the all source codes of emulators listed below:
                EmuZ-3500       MZ-3500
                EmuZ-5500       MZ-5500
                EmuZ-6500       MZ-6500
-               EmuZ-6550       MZ-6550 (work in progress)
                eSM-B-80TE      SM-B-80TE
                eX1             X1
                eX1twin         X1twin
                eX1turbo        X1turbo
-               eX1turboZ       X1turboZ (work in progress)
+               eX1turboZ       X1turboZ
        Shinko Sangyo
                eYS-6464A       YS-6464A
        SONY
@@ -117,53 +125,199 @@ This archive includes the all source codes of emulators listed below:
                eSMC-777        SMC-777
        SORD
                Emu5            m5
+       Systems Formulate
+               eBUBCOM80       BUBCOM80
        TOMY
                ePyuTa          PyuTa/PyuTa Jr.
        TOSHIBA
                eEX-80          EX-80
+               yayaHX-20+      HX-20 + FDD (by Mr.umaiboux)
                EmuPIA          PASOPIA/PASOPIA5
                EmuPIA7         PASOPIA7
-               eJ-3100GT       J-3100GT (work in progress)
-               eJ-3100SL       J-3100SL (work in progress)
+       YAMAHA
+               eYIS            YIS
        Yuasa Kyouiku System
                eYALKY          YALKY
 
+These binaries are for Windows XP/Vista/7.
+DirectX9 and GDI+ are required.
+They are tested on Windows 7 Home Premium with SP1.
 
---- How to build
 
-Build the projects with the Microsoft Visual C++ 2008 with Service Pack 1 or
-the Microsoft Visual C++ 2013 with Update 5.
+--- How to use
 
-The DirectX SDK is required.
-I recommend the DirectX 9.0 SDK Update (December 2004),
-and dinput.lib included in the DirectX 9.0 SDK Update (October 2004).
+Common menus:
 
-If you install the newer DirectX SDK, for example DirectX SDK (June 2010),
-and it does not contain dinput.lib, pelase modify src/win32/osd.h to change
-the definition of DIRECTINPUT_VERSION from 0x500 to 0x800 as follows:
+Control
+       Reset                   Reset the virtual machine
+       --------
+       CPU x1                  Set CPU clock multipler
+       CPU x2
+       CPU x4
+       CPU x8
+       CPU x16
+       Full Speed              Run simulation at full speed
+       --------
+       Paste                   Auto key hitting from the clip board text
+       Stop                    Stop the auto key hitting
+       Romaji to Kana          Enter kana letters with alphabet keys
+       --------
+       Save State              Save the virtual machine state
+       Load State              Load the virtual machine state
+       --------
+       Debug Main CPU          Open console and debug target CPU like SYMDEB
+       Close Debugger          Close debugger console
+       --------
+       Exit                    Terminate the emulator
 
-//#define DIRECTINPUT_VERSION  0x500
-#define DIRECTINPUT_VERSION    0x800
+Cart
+       Insert                  Insert the cart image
+       Eject                   Eject the cart image
+       --------
+       History                 Insert the cart image
 
-When you use the Microsoft Visual C++ 2008 with Service Pack 1,
-the Windows SDK for Windows 8.1 is also required to get the mt.exe utility.
-The mt.exe is used to merge a manifest file for Windows Vista or later.
+FD
+       Insert                  Insert the floppy disk image
+       Eject                   Eject the floppy disk image
+       --------
+       Write Protected         Set the write protection of the inserted disk
+       Correct Timing          Emulate FDC with correct timing
+       Ignore CRC Errors       Ignore crc error status
+       ----
+       History                 Insert the floppy disk image
 
-https://msdn.microsoft.com/en-us/windows/desktop/bg162891.aspx
+CMT
+       Play                    Insert the cassette tape image to play
+       Rec                     Insert the cassette tape image to record
+       Eject                   Eject the cassette tape image
+       --------
+       Play Button             Control the cassette tape recorder
+       Stop Button
+       Fast Foward
+       Fast Rewind
+       --------
+       Waveform Shaper         Enable waveform shaping for *.wav data
+       --------
+       History                 Insert the cassette tape image to play
 
-When you use the Microsoft Visual C++ 2013 with Update 5, the dir macros,
-WindowsSDK_IncludePath, WindowsSDK_LibraryPath_x86, and DXSDK_DIR shoud be
-defined and should specifies the install directories of the Windows SDK
-and the DirectX SDK.
-They are usually defined automatically when you install the SDKs.
+Device
+       Sound
+               Sound Device Types
+               --------
+               Play FDD Noise  Enable playing FDD noise (seek, head up/down)
+               Play CMT Noise  Enable playing CMT noise (relay on/off)
+               Play CMT Sound  Enable playing CMT signal sound
+       Display
+               Monitor Types
+               --------
+               Scanline        Draw scanline
 
+Host
+       Rec Movie 60fps         Record the movie to avi and wav files
+       Rec Movie 30fps
+       Rec Movie 15fps
+       Rec Sound               Record the wave file
+       Stop                    Stop recording
+       Capture Screen          Capture the screen to png file
+       --------
+       Screen
+               -
+               Window x1       Set the window size
+                       :
+               Window x8
+               Fullscreen ?x?  Set the fullscreen size
+               --------
+               Dot By Dot      Set the stretch screen mode in the fullscreen
+               Stretch (Aspect)
+               Stretch (Fill)
+               --------
+               Rotate 0deg     Rotate the screen
+               Rotate +90deg
+               Rotate 180deg
+               Rotate -90deg
+       Filter
+               RGB Filter      Enable the RGB CRT filter
+               None
+       Sound
+               2000Hz          Set the sound frequency
+               4000Hz          You need to restart the emulator
+               8000Hz
+               11025Hz
+               22050Hz
+               44100Hz
+               48000Hz
+               96000Hz
+               --------
+               50msec          Set the sound buffer size (latency)
+               100msec         You need to restart the emulator
+               200msec
+               300msec
+               400msec
+               --------
+               Realtime Mix    Mix the sound in realtime
+               Light Weight Mix
+               --------
+               Volume          Set the volume of each sound device
+       Input
+               Joystcik #1/#2  Setup Joystick buttons
+       --------
+       Use Direct3D9           Enable Direct3D9 to render screen
+       Wait Vsync              Wait Vsync when Direct3D9 is enabled
+       Use DirectInput         Enable DirectInput for keyboard
+       Disable Windows8 DWM    Disable the Desktop Window Manager
+       Show Status Bar         Show/Hide the status bar in windwo mode
 
---- License
 
-The copyright belongs to the author, but you can use the source codes
-under the GNU GENERAL PUBLIC LICENSE Version 2.
+--- Note
 
-See also COPYING.txt for more details about the license.
+For Windows PC environment:
+
+       Support Windows PC compatible mouse and joystick devices.
+
+       Accelerator key:
+               ALT+RETURN  - Switch window / fullscreen
+               CTRL+RETURN - Enable/Disenable mouse control
+               APPLICATION - Enable/Disable full speed emulation
+               CTR+APPLICATION - Enable/Disable roman to kana conversion
+
+       *) While the mouse control is enabled, the mouse cursor is hidden.
+
+Floppy disk images:
+
+       P88SR D88       (*.d88;*.d77;*.1dd)
+       TeleDisk        (*.td0)
+       ImageDisk       (*.imd)
+       CPDRead         (*.dsk)
+       T98-NEXT r0     (*.nfd)
+       Anex86          (*.fdi)
+       BKDSK           (*.hdm;*.hd5;*.hd4;*.hdb;*.dd9;*.dd6)
+
+       and any other solid images (*.tfd;*.xdf;*.2d;*.sf7;*.img;*.ima;*.vfd)
+
+Cassette tape images:
+
+       Support wav files (PCM only) or special format images for each machine.
+
+CD-ROM images:
+
+       Support BIN/IMG+CUE or IMG+CCD (CloneCD) format images.
+
+FDD noise:
+
+       Place the wave files below: FDDSEEK.WAV. HEADDOWN.WAV. HEADUP.WAV
+
+CMT noise:
+
+       Place the wave files below: RELAY_ON.WAV, RELAYOFF.WAV, FAST_FWD.WAV
+
+Save/Load State info:
+
+       The state file contains any disk or other images.
+       Please NEVER upload your state files on the web.
+
+       The state file format will be often changed.
+       Please don't invite your state file can be loaded after you update
+       the emulator binary.
 
 
 --- Thanks
@@ -174,10 +328,14 @@ See also COPYING.txt for more details about the license.
        XM6 by Mr.PI.
 - vm/fmgen/*
        M88/fmgen by Mr.CISC
+- vm/am9511.*
+       Xep128 APU core
 - vm/disk.*
        TDLZHUF for Teledisk floppy disk image decoder
        MESS formats/dsk_dsk.c for CPDRead floppy disk image decorder
        MESS formats/imd_dsk.c for ImageDisk floppy disk image decorder
+- vm/hd44102.*
+       MAME HD44102 core and soem modifications by PockEmul
 - vm/hd63484.*
        MAME HD63484 core
 - vm/huc6280.*
@@ -247,12 +405,14 @@ See also COPYING.txt for more details about the license.
        PockEmul uPD16434 core
 - vm/v99x8.*
        Zodiac V99x8 core, converted to C++ class by Mr.umaiboux
+- vm/v9938.*
+       MAME V99x8 core, converted to C++ class by Mr.umaiboux
 - vm/w3100a.*
        Mr.Oh!Ishi for the chip specification info
 - vm/z80.*
        MAME Z80 core
 - vm/z80dma.*
-       MAME Z80DMA core and improved by Mr Y.S.
+       MAME Z80DMA core and improved by Mr.Y.S.
 - vm/bmjr/*
        bm2 by Mr.maruhiro
        Mr.Enri for HITACH BASIC Master Jr hardware design info
@@ -279,6 +439,8 @@ See also COPYING.txt for more details about the license.
        Mr.Dennis Heynlein for intelligent ram disk unit
 - vm/jr100/*
        Mr.Enri for National JR-100 hardware design info
+- vm/jr800/*
+       PockEmul JR-800 driver
 - vm/m5/*
        MESS sord driver
        Mr.Moriya for Sord M5 hardware design info
@@ -306,6 +468,8 @@ See also COPYING.txt for more details about the license.
        M88 by Mr.CISC
        XM8 by Mr.PI.
        MESS PC-8801 driver
+- vm/pc9801/display.*
+       Neko Project 2 by Mr.Yui
 - vm/pcengine/pce.*
        Ootake (joypad)
        xpce (psg)
@@ -326,11 +490,17 @@ See also COPYING.txt for more details about the license.
 - vm/x07/io.*
        x07_emul by Mr.Jacques Brigaud
 - vm/x1/*
-       Many advices by Mr Y.S.
+       Many advices by Mr.Y.S.
 - vm/x1/psub.*
        X millenium T-tune by Mr.Sato
 - vm/x1/display.*
        KANJI ROM support by X1EMU
+       X1tuboZ graphic info by Mr.Sato
+- vm/yis/*
+       YAMAHA provided me some YIS manuals and software disks
+       Mr.Moriya analyzed the YIS hardware
+- vm/yis/display.*
+       KST32B stroke font and its decoder by Mr.Saka.N
 - vm/z80tvgame/*
        This homebrew cnosole is designed by Mr.Ishizu
        http://w01.tp1.jp/~a571632211/z80tvgame/index.html