README.md

   1 <H2>** Qt porting for Common Source Code Project **</H2>
   2 <div align="right">
   3 <H3>Sep 09, 2016<BR>
   4 K.Ohta <whatisthis.sowhat _at_ gmail.com></H3>
   5 </div>
   6 --- If you can't read Japanese, [english writing is here](/README.en.md/).
   7
   8 0. 概要
   9 -
  10    このパッケージは、Common Source Code Project (以下、CSP)をQt5に移植したものです。
  11
  12    バイナリはGNU/Linux(64bit)用とMinGW (32bit Windows)用を用意しています。
  13
  14    ソースコード：
  15
  16      https://github.com/Artanejp/common_source_project-fm7/ 以下
  17
  18    追加情報:
  19
  20     　各機種バイナリーは、osdn.net　もしくはミラーサイトより入手可能です。
  21
  22    　https://osdn.net/projects/csp-qt/
  23
  24      https://osdn.net/projects/csp-qt/releases/　をチェックしてください。
  25
  26 　   Win32:
  27
  28   　 GNU/Linux(amd64) :
  29
  30 *【おねがい】*
  31
  32      　doc/以下の文書で日本語しかなかったものを英語に翻訳していますが、機械翻訳を使ってるのであやしいです。
  33
  34        英語の上手い方、校正などお願いします m(_ _)m
  35
  36 1. 背景
  37
  38    CSPは、非常に優れた構造のエミュレータです（しかし、些か重くてコンパイラがいい最適化をしないと重めですが）。
  39
  40    しかし、このコードはM$ Visual C++依存の部分が非常に多いです。
  41
  42    そこで、GNU/Linuxでこれを動かすためにQtに色々と移植していきましょう。と言う感じで作業をはじめました。
  43
  44 2. 最低限必要なもの(Qt版)
  45
  46    a. Qt5 ツールキット。Qt 5.5以降を推奨します。
  47
  48    b. OpenGL, 多分、最低OpenGL 2.1は必要です。（注：ひょっとしたら、OpenGLES2以降ならば動くように変えるかも知れない）
  49
  50    c. gcc / g++ (5.0以降？)もしくは llvm clang / clang++ (3.5以降?)コンパイラツールチェーン。MS Visual StudioのC++でも大体はビルドできると思いますが、未確認。
  51
  52    d. SDL2 (SDL 1.xではないので注意)
  53
  54    e. CMake 2.8以降。
  55
  56    f. ffmpegから、libavとlibswが必要です。 http://ffmpeg.org/ より。
  57
  58    g. ffmpegは、それぞれのランタイムに必要なものをバンドルしてありますので、動かない時はインストールしてみてください。
  59
  60    h. GNU/Linuxビルドでは、Qt5.5(Ubuntu 16.04LTS向け)もしくはQt5.9(Debian GNU/Linux sid向け)でビルドしてあります。
  61
  62    * Windows もしくは GNU/Linux のcross tool chain (要Wine)で、MinGW (gcc6) と Qt 5.7 でのビルドができることを確認しました。
  63
  64    * TIPS:
  65
  66      * Windows等で動かした時に、画面の書き替えが表示されない場合は、環境変数 QT_OPENGL を software にしてみてください。（例えば、WindowsをVirtualBoxのゲストで使ってる場合など）
  67
  68      * Windows版バイナリには、ソフトウェアレンダリングのopengl32.dllが添付されてますが、最近のパソコンの専用GPUドライバなら、もっと程度のいいOpenGLが入ってるはずです。添付版opengl32.dllを適当な名前に変更して動くかどうか試してみて下さい。
  69
  70 3. ビルドの方法
  71
  72    ソースコードを解凍するか、git clone / pull した後で:
  73
  74     $ cd {srctop}/source/build-cmake/{Machine name}/
  75     $ mkdir build
  76     $ cd build
  77
  78 To configure:
  79
  80     $ cmake ..
  81
  82 or
  83
  84     $ ccmake ..
  85
  86 To build:
  87
  88     $ make
  89
  90 To install:
  91
  92     $ sudo make install
  93
  94 4. Qt固有の話(Windows除く)
  95
  96    *ToolTipsを付けました。(2017-01-24)
  97
  98    *日本語に翻訳しました。(2017-01-24)
  99
 100    *R@Mを $HOME/emu{Machine Name}/　に配置してください。(Windowsの場合は今の所 .\emu{Machine Name}\)。なお、このディレクトリは最初起動した後で作成されます。
 101
 102    *設定ファイルは、$HOME/.config/emu{Machine Name}/ に書き込まれます。(Windowsの場合は今の所 .\.config\emu{Machine Name}\)
 103
 104    *ステートセーブファイルは、$HOME/emu{Machine Name}/{Machine Name}.sta に書き込まれます。
 105
 106    *キーコード変換テーブルファイルが、$HOME/.config/emu{Machine Name}/scancode.cfg に書き込まれます。
 107
 108      書式は、カンマで区切られた16進データです(10進ではないので注意) .
 109
 110      1カラム目はM$ ヴァーチャルキーコード。
 111
 112      2カラム目はQtネィティブのスキャンキーコードです。
 113
 114    *UI部分の共通コンポーネント (src/qt/gui) を共有ライブラリlibCSPgui.soにまとめました。
 115
 116    *インストール用のBASHスクリプトを用意しました。src/tool/installer_unix.shです。
 117
 118    *ROMと同じところに、特定のWAVファイル(VMによって異なる)を入れると、FDDのシーク音やテープのボタン音・リレー音を鳴らすことが出来ます。
 119
 120    *ローマ字カタカナ変換支援機構が一部の機種に実装されてます。romaji_kana.ja.txt をお読みください。
 121
 122 5. 移植状況
 123
 124    a.現在、Debian GNU/Linux "sid"と、Ubuntu Linux 16.04LTS "Xenial"の AMD64版、後はWindowsのMinGWでしかテストしていません。
 125
 126    　が、多分他のGNU/Linux OSやBSD系のOS (Mac含む) でもビルドすれば動くでしょう。
 127
 128      Windows もしくは GNU/Linux(要Wineとbinfmt-support)上でのMinGWとQt community edition でのビルドが通るようになりました。
 129
 130    b. 今は、Qtの開発側が「Qt4おわりね」とアナウンスしたので、Qt4ではなくQt5を使っています。
 131
 132       添付してあるバイナリは、Qt 5.5でビルドしました(が、Qt 5.1以降なら動くはずです)。
 133
 134    c. Linux用ビルドでは、GCCをリンク時最適化(LTO)モードで使っています。
 135
 136    d. MZ-2500のソケット機能を実装してみていますが、マトモにテストできてません(；´Д｀)
 137
 138 6. Upstream repositry:
 139 -
 140       https://github.com/Artanejp/common_source_project-fm7
 141
 142       https://osdn.net/projects/csp-qt/scm/git/common_source_project-fm7
 143
 144 7. Project Page:
 145 -
 146       https://osdn.jp/projects/csp-qt/
 147
 148 8. Upstream (Takeda Toshiyaさんのオリジナル)
 149 -
 150       http://takeda-toshiya.my.coocan.jp/
 151
 152
 153 Special thanks to:
 154 -
 155   Ryu Takegami : eFM-8/7/77/AV/40/EX のデバッグに協力していただいています。
 156
 157 Have fun!
 158
 159 --- Ohta.
 160
 161