Skip to content

Latest commit

 

History

History

msx2-ios

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
MSX2.xcodeproj
MSX2.xcodeproj
 
 
MSX2
MSX2
 
 
app-objc
app-objc
 
 
app-swift
app-swift
 
 
MSX2.podspec
MSX2.podspec
 
 
README.md
README.md
 
 
screen_objc.png
screen_objc.png
 
 

README.md

micro MSX2+ for iOS

About

Swift-UI は正直な所その学習コストに見合うメリットが微妙というか、「これなら Flutter を使った方が良いよね」と思っている節があります。

Basic Usage

Pods (WIP)

Podfile に 次の行を追加してください。

pod 'MSX2', :podspec => 'https://raw.githubusercontent.com/suzukiplan/micro-msx2p/master/msx2-ios/MSX2.podspec'

例: MyApp というアプリの場合

target 'MyApp' do
  use_frameworks!
  pod 'MSX2', :podspec => 'https://raw.githubusercontent.com/suzukiplan/micro-msx2p/master/msx2-ios/MSX2.podspec'
end

基本的な使い方 (Swift)

1. Import

import MSX2

2. Initialize

MSX2View は初期化処理が完了するまでブラックスクリーンの状態でサスペンド状態になり、setupWithCBiosMain メソッドでC-BIOSイメージやゲームのROMイメージの読み込みが完了することで実行状態に遷移します。

初期化処理は、ファイルI/Oなどの時間が掛かる処理の実行が必要なため、DispatchQueue.global(qos: .default).async を用いてサブスレッドで非同期に実行することが望ましいです。

以下、サブスレッドを用いた初期化処理を ViewController の viewDidLoad で実装する例を示します。

DispatchQueue.global(qos: .default).async {
    let main = NSData(contentsOfFile: Bundle.main.path(forResource: "cbios_main_msx2+_jp", ofType: "rom")!)!
    let logo = NSData(contentsOfFile: Bundle.main.path(forResource: "cbios_logo_msx2+", ofType: "rom")!)!
    let sub = NSData(contentsOfFile: Bundle.main.path(forResource: "cbios_sub", ofType: "rom")!)!
    let rom = NSData(contentsOfFile: Bundle.main.path(forResource: "game", ofType: "rom")!)!
    self.msx2View.setup(withCBiosMain: main as Data,
                        logo: logo as Data,
                        sub: sub as Data,
                        rom: rom as Data,
                        romType: .normal,
                        select: 0x1B,
                        start: 0x20)
}

3. Set Delegate

MSX2View を扱う ViewController などで MSX2ViewDelegate の実装を行います。

class ViewController: UIViewController, MSX2ViewDelegate {
func didRequirePad1Code(with view: MSX2View) -> Int {
    virtualPadView.joyPad.code
}

func didStart(with view: MSX2View) {
}

func didStop(with view: MSX2View) {
}
  • didRequirePad1Code ジョイパッドの入力コードを返します（毎フレームコールバックされます）
  • didStart エミュレータが開始する直前にコールバックされます
  • didStop エミュレータが停止する直前にコールバックされます

基本的な使い方 (Objective-c)

1. Impoort

@import MSX2;

フレームワーク MSX2 を import することで、主に以下のクラスを用いて micro-msx2p を用いたアプリを実装できます。

  • MSX2Core micro-msx2p コアモジュールの Objective-c ラッパー（上級者向け）
  • MSX2View micro-msx2p が iOS で簡単に扱える UIView 派生の View

以下、MSX2View の扱い方について解説します。

2. Initialize

MSX2View は初期化処理が完了するまでブラックスクリーンの状態でサスペンド状態になり、setupWithCBiosMain メソッドでC-BIOSイメージやゲームのROMイメージの読み込みが完了することで実行状態に遷移します。

初期化処理は、ファイルI/Oなどの時間が掛かる処理の実行が必要なため、dispatch_async を用いてサブスレッドで非同期に実行することが望ましいです。

以下、サブスレッドを用いた初期化処理を ViewController の viewDidLoad で実装する例を示します。

__weak ViewController* weakSelf = self;
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
    NSData* main = [NSData dataWithContentsOfFile:[[NSBundle mainBundle] pathForResource:@"cbios_main_msx2+_jp" ofType:@"rom"]];
    NSData* logo = [NSData dataWithContentsOfFile:[[NSBundle mainBundle] pathForResource:@"cbios_logo_msx2+" ofType:@"rom"]];
    NSData* sub = [NSData dataWithContentsOfFile:[[NSBundle mainBundle] pathForResource:@"cbios_sub" ofType:@"rom"]];
    NSData* rom = [NSData dataWithContentsOfFile:[[NSBundle mainBundle] pathForResource:@"game" ofType:@"rom"]];
    [weakSelf.msx2View setupWithCBiosMain:main
                                        logo:logo
                                        sub:sub
                                        rom:rom
                                    romType:MSX2RomTypeNormal
                                    select:0x1B
                                    start:0x20];
});

3. Set Delegate

MSX2View を扱う ViewController などで MSX2ViewDelegate の実装を行います。

@interface ViewController () <MSX2ViewDelegate>
- (NSInteger)didRequirePad1CodeWithView:(MSX2View*)view
{
    return 0;
}

- (void)didStartWithView:(MSX2View*)view
{
    NSLog(@"Emulator start");
}

- (void)didStopWithView:(MSX2View*)view
{
    NSLog(@"Emulator stop");
}
  • didRequirePad1CodeWithView ジョイパッドの入力コードを返します（毎フレームコールバックされます）
  • didStartWithView エミュレータが開始する直前にコールバックされます
  • didStopWithView エミュレータが停止する直前にコールバックされます

Example

app-swift ディレクトリと app-objc ディレクトリ以下が MSX2View を用いたアプリケーション実装の例です。

image

  • ViewController.swift または ViewController.m の実装を見れば MSX2View の使い方を簡単に把握できるようになっています
  • XCODE でビルドすれば roms に組み込まれた game.rom が起動します
  • デフォルトの game.rom は Hello, World! を表示するシンプルな ROM ファイルです
  • game.rom を置き換えることで任意のゲームを起動できます
  • メガロムを起動する時は初期化時に指定している romType を適切に変更してください

Advanced Usage

MSX2View を用いることで、iOSで簡単に micro-msx2p を用いることができますが、コアモジュールの機能をそのまま利用できる MSX2Core を用いることで、micro-msx2p の全ての機能を活用した高度なプログラムを開発することもできます。

License

本プログラムには次の OSS が含まれています。利用に当たっては、著作権（財産権）及び著作者人格権は各作者に帰属する点の理解と、ライセンス条項の厳守をお願いいたします。

  • LZ4 Library
  • C-BIOS
    • Web Site: https://cbios.sourceforge.net/
    • License: 2-Clause BSD
    • Copyright (c) 2002-2005 BouKiCHi. All rights reserved.
    • Copyright (c) 2003 Reikan. All rights reserved.
    • Copyright (c) 2004-2006,2008-2010 Maarten ter Huurne. All rights reserved.
    • Copyright (c) 2004-2006,2008-2011 Albert Beevendorp. All rights reserved.
    • Copyright (c) 2004-2005 Patrick van Arkel. All rights reserved.
    • Copyright (c) 2004,2010-2011 Manuel Bilderbeek. All rights reserved.
    • Copyright (c) 2004-2006 Joost Yervante Damad. All rights reserved.
    • Copyright (c) 2004-2006 Jussi Pitkänen. All rights reserved.
    • Copyright (c) 2004-2007 Eric Boon. All rights reserved.
  • emu2413
  • SUZUKI PLAN - Z80 Emulator
  • micro MSX2+

app-objcディレクトリ配下とMSX2ディレクトリ配下のソースコードは全て micro MSX2+ の一部として同じライセンス下で利用可能です。