Skip to content

Latest commit

 

History

History
100 lines (73 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

100 lines (73 loc) · 2.94 KB
Raw

コントリビューションについて

このエミュレータに関するいろんな情報はScrapboxに載っています。 https://scrapbox.io/kmc-n64/

質問はKMC Slackのtamaronまでお願いします。 Slackチャンネル: #n64-emu

コントリビューションの方法

Issueにも載っていますが、例えば以下の形で貢献してほしいです。

  • エミュレーションの実装をすすめる
  • テストの追加、整備
  • デバッガの整備
  • バグ検証
  • 各プラットフォームの動作確認、ビルド環境整備

フォーマッタ

clang-formatを使用してください

デバッグ

CPUの命令ログを有効化するには定数LOG_INSTRUCTIONにtrueをセットしてください。

WindowsでVSCodeを利用している場合は、.vscode/launch.jsonを作成し、以下を書き込むことでGUIとしてデバッガを利用できます。

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "C++ Launch (Windows)",
      "type": "cppvsdbg",
      "request": "launch",
      "program": "${workspaceFolder}\\build\\src\\Debug\\n64.exe",
      "args": ["${workspaceFolder}\\<your-rom.z64>"],
      "externalConsole": true,
      "logging": {
        "moduleLoad": false,
        "trace": true
      },
      "cwd": "${fileDirname}"
    }
  ]
}

https://code.visualstudio.com/docs/editor/debugging

コーディング規約

命名規則

  • 普通の変数, 関数名, typedefした型の名前: snake_case, snake_case_t
  • Class, Struct, Enum: PascalCase
  • 定数, Enumのケース: UPPER_SNAKE_CASE

その他言及されていない箇所は変更するファイルに従ってください

リファレンス

基本的な64のハードウェア固有の仕様はn64brewに載っています。 https://n64brew.dev/wiki/Main_Page

プロセッサの仕様は仕様書を参照してください。

また、実装は基本的に、Project64、n64、Kaizenを参考にしています

Project64はおそらく最も正確です。できる限り、こちらを参照してください。 Kaizenはn64を参考にして作られたため、ほとんど同じです。(違いはCかC++か) 実装する際は、この二種類の実装を確認したのち、ソースコード中に該当箇所のパーマリンクを貼ってください。あとから確認しやすくするためです。

コード補完

Windows + VSCode

  1. VSCodeの拡張機能のCMake Toolsをインストール
  2. プロジェクトのルートに.vscode/settings.jsonを作成し、以下を書き込む
{
  "C_Cpp.intelliSenseEngine": "default",
  "makefile.configurations": [
    {
      "name": "MyConfiguration",
      "problemMatchers": ["$msCompile"],
      "makeArgs": []
    }
  ]
}

Linux / macOS

CMakeでcompile_commands.jsonを出力し、clangdを起動する