README.md

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