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