game and watch patch

新しい任天堂ゲームとウォッチコンソール用のカスタムファームウェア。

これは何ですか？

このリポジトリには、カスタムコードとパッチングユーティリティが含まれており、ストックゲームやウォッチファームウェアに機能を追加します。要するに、このプロジェクトを使用すると、ゲームを実行して、レトロゴーと一緒に視聴することができます。

特徴

• 内部フラッシュバンク2のレトロゴーで正しく動作します。
• ボタンの組み合わせ（ LEFT + GAME ）を押して、内部フラッシュバンク2からレトロゴーを起動します。
• すべての構成オプションを確認するためのmake help実行します。

Mario（ PATCH_PARAMS="--device=mario" ）

• ファームウェア全体を内部フラッシュに保存する機能！外部フラッシュは必要ありません！
  • 「マリオの歌」イースターエッグを削除するオプション。
  • 5つの睡眠イラストを削除するオプション。
  • LZMA圧縮データ。
  • できるだけ多くのデータを内部ファームウェアにインテリジェントに移動します。
• 構成可能なタイムアウト。
• --smb1=path-to-patched-smb1-rom.nesを介してSMB1 ROMハッキングを再生する機能
• SMB1 ROMハックスプライトをクロック用に動的にロードする機能--smb1-graphics=path-to-patch.ips
  • 最大8つの追加グラフィックセットを追加できます。
  • クロック画面のダウンボタンを介してサイクリングします。
  • すべてのIPSファイルをips/に追加し、パッチャーにフラグを介してそれらを自動的に発見させます--smb1-graphics-glob
• 他のエミュレーターが再生可能なSMB1およびSMB2 ROMをダンプします。
• 詳細については、Marioドキュメントを参照してください。

Zelda（ PATCH_PARAMS="--device=zelda" ）

• --no-beep経由で2番目のビープ音を時間/時計で削除する能力
• 将来的に来る外部フラッシュの節約。
• 詳細については、Zeldaドキュメントを参照してください。

使用法

このレポは、GNWManager CLIツールを使用します。インストール方法に関する指示を参照してください。

Game-and-Watch-Patch Python依存関係（> = python3.6必須）をインストールしてください。

 pip3 install -r requirements.txt

internal_flash_backup_${DEVICE}.bin and flash_backup_${DEVICE}.binこのリポジトリのルートに配置します。 GNWシステムからこれらを抽出するには、GNWManagerのロック解除チュートリアルを参照してください。たとえば、 marioゲームにパッチを適用して監視している場合、このプロジェクトのルートディレクトリにinternal_flash_backup_mario.binおよびflash_backup_mario.binが必要です。

デバイスモデルについては、以下の適切なセクションを参照してください。

追加の構成オプションについては、 make help実行します。

レトロゴー（マリオ）

ほとんどの人はレトロゴーでこれを使用し、使用される外部ストレージの最小量を必要とし、眠っている画像やマリオの歌のイースターエッグを気にしないでください。ここに推奨コマンドがあります。これにより、文書化されていない128kbの内部銀行1が使用されており、PASTEDバージョンのOpenOCDがインストールされていることに注意してください。

 # in this repo
make clean
make PATCH_PARAMS="--device=mario --internal-only" flash

# in the retro-go repo
make clean
make -j8 INTFLASH_BANK=2 flash

Retro Go（Zelda）

これは、外部フラッシュを4MBより大きなものにアップグレードしたことを前提としています。ストック4MBフラッシュチップでレトロゴーを使用するZeldaドキュメントを参照してください。

 # in this repo
make clean
make PATCH_PARAMS="--device=zelda" flash

# in the retro-go repo
make clean
# In this example, I'm assuming you have a 64MB flash chip (60 = 64 - 4)
make -j8 EXTFLASH_SIZE_MB=60 EXTFLASH_OFFSET=4194304 INTFLASH_BANK=2 flash

Dockerを使用してビルドとフラッシュ

Dockerに精通しており、ツールチェーンなどを手動でインストールする必要がないソリューションを好む場合は、このセクションを展開して読み続けてください。

さまざまなソフトウェアのインストールにおける潜在的な落とし穴の数を減らすために、Nintendo®Mame＆Watch™システムにカスタムファームウェア（CFW）をコンパイルおよびフラッシュするために必要なすべてを含むDockerFileが提供されます。このDockerfileは、Linuxを実行するX86-64マシンのタグ付けと書かれています。

Dockerコンテナからフラッシュする手順（Linuxで実行されています。たとえば、ArchlinuxまたはUbuntuなど）：

 # Go into the docker directory of this repo.
cd docker/

# Pull the pre-built docker image.
docker pull brianpugh/game-and-watch-patch:latest

# When done, use the image to create a container with the attached docker-compose.yaml file.
# You have to edit the compose file and set the path to the directory with your firmware backup (volumes section of the file).
docker compose up -d

# This will create and run a container game-and-watch-patch.
# The firmware backup files will be mounted into /tmp/firmware of the container.
# Now, go inside the container copy the backup files and proceed as described above in the Usage section.
docker exec -it game-and-watch-patch /bin/bash

許可の問題に遭遇した場合は、ユーザーがDockerグループにいることを確認してください。

トラブルシューティング/FAQ：

RPI3にPython依存関係keystone-engineをインストールできません

Raspberry Pi 3にkeystone-engineインストールできない場合は、次のことを試してください。

1. raspi-configからGPU RAMを16MBに更新します
2. ソースからキーストーンエンジンを構築およびインストールします（〜15分かかるはずです）：

 git clone https://github.com/keystone-engine/keystone
cd keystone/bindings/python/
python3 -m pip install .

発達

機能を開発するための主要な段階：

1. ストックROM（通常は関数呼び出し）で制御する場所を見つけます。
2. Core/Inc/stock_firmware.hにストック関数とそのアドレスを追加します。
3. おそらくCore/Src/main.cに独自の関数を実装してください。カスタム関数が（2）で関数を呼び出す可能性が十分にあります。また、おそらく-Wl,--undefined=my_custom_function makefileのLDFLAGSに追加する必要があるため、到達不可能なコードとして最適化されないようにする必要があります。
4. patches/patches.pyにパッチ定義を追加します。

ジャーナル

閉じたソースバイナリ用のパッチを開発したのはこれが初めてです。私はそれが他の人を助けることを期待して私の旅を文書化しました。推奨事項、ヒント、トリックなどがある場合は、GitHubの問題を残して、ドキュメントを更新してください。

了承

これを可能にしたコミュニティに感謝します！このレポは、他の人の助けを借りて構築されました。このプロジェクトの開発中に参照されるリポジトリ：

• KbeckmannによるGame-and-Watch-Retro-Go
• Ghidraninjaによるゲームとウォッチのバックアップ
• Ghidraninjaによるゲームとウォッチベース
• GMMANによるゲームとウォッチデクライプ
• JaamesによるGame-and-Watch-Drawing-Song-Re

また、すべての助けについてStackmashing Discordに感謝したいと思います（@cyanicへの特別な叫び声）！