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