source/readme.qt.txt

   1 ** Qt porting for Common Source Code Project **
   2                                           Jan 24, 2017
   3               K.Ohta <whatisthis.sowhat _at_ gmail.com>
   4
   5 0. About
   6    This package is Qt5 porting of Common Source Code Project (CSP).
   7    Building with GNU/Linux(64bit) and MinGW(32bit Windows).
   8
   9 1. Background
  10    Common Source Code Project (CSP) is good emulator writing.
  11    But codes are specified to M$ Visual C.
  12    I'm using GNU/Linux, and I starting to apply FM-7(or later).
  13    So, I start to port to GNU/Linux and using Qt4.
  14
  15    * Note: You can build with MinGW32 and Qt 5.7(for MinGW).
  16
  17    * TIPS: If emufoo.exe don't show screen drawing, set environment
  18            variable QT_OPENGL to software (i.e. Using Windows as VirtualBox's gueat OS).
  19
  20 2. What you need at least:
  21    a. Qt5 (neither Qt3 and Qt4) toolkit.
  22    b. Some OpenGL implementation, maybe at leaset OpenGL v2.1.
  23    c. gcc / g++ (4.7 or later? ) or llvm clang / clang++ (3.5 or later?) toolchain.
  24    d. SDL2 (not SDL1.x).
  25    e. CMake 2.8 or later.
  26    f. libav and libsw from ffmpeg (optional) http://ffmpeg.org/ .
  27
  28 3. How to build:
  29    After extracting (or git pulled) sourcecodes:
  30    $ cd {srctop}/source/build-cmake/{Machine name}/
  31    $ mkdir build
  32    $ cd build
  33
  34    To configure:
  35    $ cmake ..
  36    or
  37    $ ccmake ..
  38
  39    To build:
  40    $ make
  41
  42    To install:
  43    $ sudo make install
  44
  45 4.Qt specified notice (for non-Windows):
  46    ・Added ToolTips and Japanese translations.(2017-01-24)
  47    ・Place R@Ms under $HOME/emu{Machine Name}/ , this directory has made
  48      after first using.
  49    ・Config file, {foo}.ini is written on $HOME/.config/emu{Machine Name}/ .
  50    ・Saved state file, {foo}.sta is written on $HOME/emu{Machine Name}/ .
  51    ・Key code conversion file is written on $HOME/.config/emu{Machine Name}/scancode.cfg .
  52      This file contains comma separated fields, written at hex-decimal (not decimal),
  53      first is M$ Virtual Key Code,
  54      second is Qt's scan code.
  55    ・Common UI components (at src/qt/gui ) are moved to shared lib. libCSPgui.so .
  56    ・Installer (bash) script is available now; src/tool/installer_unix.sh .
  57    ・When you place specified WAV files(differ per VM) same directory as ROMs, you can sound sounds: i.e. FDD seek, CMT relay and buttons.
  58
  59 5.Status
  60 a. I tested to build only under Debian GNU/Linux "sid" and
  61    Ubuntu Linux 16.04LTS (Xenial).
  62    But, perhaps, will succed to build another GNU/Linux OSs or BSD OS variants.
  63    * On windows, using MinGW is already okay.
  64    * Cross building with GNU/Linux's MinGW32 (GCC6) and Qt5.7 (for MinGW) is available.
  65      Modify and use build-cmake/config_build_cross_win32.sh and related *.cmake files.
  66    * And, you can also build with M$ Visual Studio 2013 or 2015.
  67
  68   b. Now, I using Qt5 as toolkit, because authors of Qt announced
  69      "Qt4 is obsolete, will be updated no longer".
  70
  71   c. All of virtual machines of upstream (@Apr 13, 2016) are ported to Qt.
  72   d. Implement socket feature using by MZ-2500, but not enough to test (；´Д｀)
  73   e. Now using GCC-6 with Link Time Optimize to build for distrubuted binaries.
  74
  75 6. Upstream repositry:
  76       https://osdn.jp/projects/csp-qt/
  77       https://github.com/Artanejp/common_source_project-fm7
  78       https://www.pikacode.com/Artanejp/common_source_project-fm7/
  79
  80 7. Upstream (Takeda Toshiya San's original code)
  81       http://takeda-toshiya.my.coocan.jp/
  82
  83 Have fun!
  84 -- Ohta.