Skip to content

Instantly share code, notes, and snippets.

@yswallow

yswallow/PRK-Configurator-design.md

Created December 4, 2022 03:50
Show Gist options
  • Save yswallow/942a960f1158c2ea4d7bf88a4effb4b7 to your computer and use it in GitHub Desktop.
Save yswallow/942a960f1158c2ea4d7bf88a4effb4b7 to your computer and use it in GitHub Desktop.
Download ZIP
PRK設定アプリの設計
Raw
PRK-Configurator-design.md
  • 設計者は各キーボードのGitHubリポジトリのルートに prk_info.jsonを置く
  • 設定アプリはusername/keyboard_nameの指定を受けてprk_info.jsonを取りに行く（無理かも）
  • 保存ファイル名はkeymap.rb
  • keymap.rbからの読み込み機能も付ける。エリアの識別はコメントで行う。
  • prk_info.jsonに含まれる情報
    • 準拠バージョン(0.0.1)
    • キー配置・物理配置と論理配置の読み替え（KLE？）
    • 1レイヤーのキー数
    • 機能
      • 各機能の使用ピン
      • RGBの個数
      • RGB Matrix
    • init_matrix_pins
    • keyboard_before_init（例: LEDに通電させる）
    • keyboard_post_init（？）
  • 設定項目
    • キーマップ
      • Remap的に
      • 基本的なmode_key(BOOTSEL)はデフォルトで追加する
    • 機能
      • 機能にチェックを入れると設定項目が有効になる
      • requireやinitを自動で追加する
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment