# sgdkx
sgdkx は、SGDK（Sega Genesis Development Kit）を用いた開発を支援する CLI ツールです。
---
## インストール方法
### sgdkx のインストール（cargo）
```sh
cargo install sgdkx
```
### 必要なツールのインストール（macOS）
以下のツールが必要です。Homebrew でインストールできます。
```sh
brew install make openjdk compiledb
brew tap gcenx/wine
brew install --cask --no-quarantine wine-crossover
brew install doxygen # options
```
- `git` は多くの場合プリインストールされていますが、必要に応じて `brew install git` でインストールしてください。
- コマンドなしで実行すると、環境チェックが動作します。必要なツールがインストールされているか確認できます。
## 使い方
主なコマンドは以下の通りです。
- `sgdkx`<br>
環境チェック・SGDK やエミュレータの設定状況・ヘルプを表示します。
- `sgdkx setup [--version バージョン]`<br>
SGDK（Sega Genesis Development Kit）をダウンロード・インストールします。<br>
`--version` でブランチ名・タグ名・コミット ID（省略時は master）を指定できます。<br>
例:
- `--version V2.11` でタグ V2.11
- `--version ef9292c0` でコミット ID ef9292c0<br>
SGDK のパスやバージョンは config.toml に保存されます。<br>
さらに、**doxygen がインストールされていて SGDK ドキュメントが存在しない場合は、自動的にドキュメントを生成します。**
- `sgdkx setup-emu [gens|blastem]`<br>
エミュレータ（gens または blastem）をダウンロード・セットアップします。<br>
インストールしたエミュレータのパスは config.toml に保存されます。
- `sgdkx new <プロジェクト名>`<br>
SGDK サンプルから新しいプロジェクトを作成します。<br>
- `sgdkx run [--emulator gens|blastem] [--rom パス]`
エミュレータで ROM ファイルを実行します。<br>
`--emulator` でエミュレータ（gens または blastem）、`--rom` で ROM ファイルのパスを指定できます（どちらも省略可能、デフォルトは自動検出/`out/rom.bin`）。
- `sgdkx uninstall [--config-only]`
SGDK のアンインストールと設定ファイルの削除を行います。<br>
また、`setup-emu` でインストールしたエミュレータ（gens/blastem）も、config.toml に記載されたパスを参照して削除されます。
- `sgdkx doc`
SGDK ドキュメントが存在すればブラウザで開きます。
#### 実験的な機能
- `sgdkx setup-web`
Webエミュレータ用テンプレートを設定します。
- `sgdkx web-export [--rom <パス>] [--dir <親ディレクトリ>]`
ROMファイルとWebエミュレータ用テンプレートをエクスポートします。<br>
このコマンドはWebエミュレータのテンプレート（HTML/JS/WASM）とROMを指定ディレクトリ配下の `web-export` ディレクトリにコピーします。
- `sgdkx web-server [--dir <ディレクトリ>] [--port <ポート>]`
`web-export` ディレクトリを組み込みHTTPサーバで公開します（WASM対応のCOOP/COEPヘッダ付き）。<br>
デフォルトでは `web-export` ディレクトリを `localhost:8080` で公開します。<br>
ディレクトリやポートはオプションで変更できます。<br>
例: `sgdkx web-server --dir web-export --port 9000`
### 簡単な使い方例
```sh
sgdkx setup --version v2.11 # stable
sgdkx setup-emu
sgdkx new your_project
cd your_project
make
sgdkx run
```
### 参考: コマンドなしで実行した場合の出力例
```
Unofficial tools for SGDK workflow
Usage: sgdkx [COMMAND]
Commands:
setup Setup SGDK for development
doc Show SGDK documentation status
setup-emu Setup emulator for running ROM files
new Create a new SGDK project
run Run ROM file with emulator
uninstall Uninstall SGDK installation and configuration
web-export Export ROM and web emulator template for web deployment
web-server Serve web-export directory with HTTP server (with COOP/COEP headers)
open Open SGDK installation directory
setup-web Setup web export template
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
🩺 sgdkx Environment Check
✅ git: /opt/homebrew/bin/git
✅ make: /usr/bin/make
✅ java: /opt/homebrew/opt/openjdk/bin/java
✅ compiledb: /opt/homebrew/bin/compiledb
✅ doxygen: /opt/homebrew/bin/doxygen
✅ wine: /opt/homebrew/bin/wine
📝 sgdkx Configuration: /Users/[user]/.sgdkx/data/config.toml
SGDK Path : /Users/[user]/.sgdkx/data/SGDK
Version : v2.11
Commit ID : ef9292c03fe33a2f8af3a2589ab856a53dcef35c
Gens Path : /Users/[user]/.sgdkx/data/gens/gens.exe
blastem Path: Not installed
📄 SGDK documentation: /Users/[user]/.sgdkx/data/SGDK/doc/html/index.html
```
## 謝辞・依存プロジェクト
- [SGDK (by Stephane-D)](https://github.com/Stephane-D/SGDK)
- [SGDK_wine (by Franticware)](https://github.com/Franticware/SGDK_wine)
- [jgenesis (by James Groth)](https://github.com/jsgroth/jgenesis)
これらの素晴らしいプロジェクトに感謝します。
## 注意事項
- このツールは開発中です。
- Linuxでのテストが十分に行えていないため、Linuxユーザーの方はご注意ください。