procon_bypass_man 0.1.16.1 → 0.1.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5af6fb77bbbd2aca55c93c8af1bb9c72ede43a043f069001b30201bf8352e7de
-  data.tar.gz: 5607eb2f41d4a09de6e7e04cb8afcf998c09d790931ed105dbe5136c7160698a
+  metadata.gz: 51f609e2bfb3366e10ae0cf76380ad969416040b73e0a4d0db91f6df783f0264
+  data.tar.gz: ea030a8b78a102b9ef8e6c12fab196b7aab2d2b91519f57e0dc63327ca57f4b1
 SHA512:
-  metadata.gz: f21c116b2d69b79a2c896cd8c1298a1e80d82c2c879e0e0db328b64f9abb19901da93edd0a88d64314413092bfafead55a9ab359f9e09a2546794812178701e1
-  data.tar.gz: 89d32cbe122d38ad19d55481539a05cfad959695d46c29d2dc6db8ac34eb251a2f2f49d7ab36f5d514e191751ba19f747dd13e5a21fd4cde4ae435a93ce117de
+  metadata.gz: 074f5f69ce22021c0a1393883d0a7cc5c20437ba77206968d1041d18ace23938e586b760aa480a4deca8f8e85904cc36d728890affc669e793911575a3fd7f36
+  data.tar.gz: f6240a68720f29e76a214a34015062f6c78ae3bb1c6691d6c3f39e70ae3c3b87823ec50412efb6fe84ad9611f005b3cf82d470bc8b87238c6213af031c5642aa

data/.circleci/config.yml

@@ -15,33 +15,108 @@ executors:
       BUNDLE_JOBS: 4
     working_directory: ~/app
 
+commands: &commands
+  bundle_install:
+    parameters:
+      ruby-version:
+        type: string
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - gem-cache-v1-<< parameters.ruby-version >>-{{ arch }}-{{ .Branch }}-{{ checksum "Gemfile.lock" }}
+            - gem-cache-v1-<< parameters.ruby-version >>-{{ arch }}-{{ .Branch }}
+            - gem-cache-v1
+      - run: gem i bundler && bundle install --path vendor/bundle --jobs 100 && bundle clean
+      - save_cache:
+          key: gem-cache-v1-<< parameters.ruby-version >>-{{ arch }}-{{ .Branch }}-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
 jobs:
+  bundle_install:
+    parameters:
+      ruby-version:
+        type: string
+    executor:
+      name: ruby
+      tag: << parameters.ruby-version >>
+    steps:
+      - bundle_install:
+          ruby-version: << parameters.ruby-version >>
+  lint:
+    parameters:
+      ruby-version:
+        type: string
+    executor:
+      name: ruby
+      tag: << parameters.ruby-version >>
+    steps:
+      - bundle_install:
+          ruby-version: << parameters.ruby-version >>
+      - run: bundle exec rubocop -P
+  type_check:
+    parameters:
+      ruby-version:
+        type: string
+    executor:
+      name: ruby
+      tag: << parameters.ruby-version >>
+    steps:
+      - bundle_install:
+          ruby-version: << parameters.ruby-version >>
+      - run: bundle exec steep check
   rspec:
     parameters:
-      version:
+      ruby-version:
         type: string
     executor:
       name: ruby
-      tag: << parameters.version >>
+      tag: << parameters.ruby-version >>
     steps:
-      - checkout
-      - run: ruby --version
-      - run: bundle --version
-      - run: gem --version
-      - run: gem install bundler
-      - run: bundle install --jobs 4
-      - run: bundle exec rubocop
+      - bundle_install:
+          ruby-version: << parameters.ruby-version >>
       - run: bundle exec rspec
-      - run: bundle exec steep check
 
 build_jobs: &build_jobs
+  - bundle_install:
+      matrix:
+        parameters:
+          ruby-version:
+            - "2.7"
+            - "3.0.1"
+            - "3.0.2"
+            - "3.1.0"
+  - lint:
+      matrix:
+        parameters:
+          ruby-version:
+            - "2.7"
+            - "3.0.1"
+            - "3.0.2"
+            - "3.1.0"
+      requires:
+        - bundle_install
+  - type_check:
+      matrix:
+        parameters:
+          ruby-version:
+            - "2.7"
+            # - "3.0.1" # たまにSEGVするので
+            - "3.0.2"
+            - "3.1.0"
+      requires:
+        - bundle_install
   - rspec:
       matrix:
         parameters:
-          version:
+          ruby-version:
             - "2.7"
             - "3.0.1"
             - "3.0.2"
+            - "3.1.0"
+      requires:
+        - bundle_install
 workflows:
   version: 2
   build:

data/.github/workflows/release.yml

@@ -13,10 +13,10 @@ jobs:
     - uses: actions/checkout@v2
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
-    - name: Set up Ruby 2.6
+    - name: Set up Ruby 3.0.1
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6
+        ruby-version: 3.0.1
         bundler-cache: true
     - name: Publish to RubyGems
       run: |

data/.rubocop.yml

@@ -24,3 +24,5 @@ Lint/EmptyBlock:
     Enabled: false
 Lint/ReturnInVoidContext:
     Enabled: false
+Lint/AssignmentInCondition:
+    Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [0.1.19.1] - 2022-02-09
+- 設定ファイルをpbm-cloudから復元するときに設定ファイルの改行コードが消える不具合を修正しました
+
+## [0.1.19] - 2022-02-09
+- 設定ファイルを再読み込みするときに構文がエラーがあると、接続が切れる不具合を修正しました
+- ~設定ファイルをpbm-cloudから復元するときに設定ファイルの改行コードが消える不具合を修正しました~
+
+## [0.1.18] - 2022-02-05
+- macroでできることが増えました
+  - 1ステップで複数のボタン入力と継続時間を指定ができるようになりました
+- スプラトゥーン2用のバブル即割マクロ(SokuwariForSplashBomb)が使えるようになりました
+  - https://github.com/splaplapla/procon_bypass_man-splatoon2
+
+## [0.1.17] - 2022-01-26
+- procon_bypass_man_cloudに組み込むために、内部のデータ構造を変更しました
+- 設定ファイルにmacroを直接打ち込めるようになりました
+  - ex) `open_macro :special_command, steps: [:x, :y, :up], if_pressed: [:y]`
+
 ## [0.1.16.1] - 2022-01-22
 - 初期状態ではinternal api(pbm-web)の通信を無効にしました
 

data/Gemfile

@@ -11,6 +11,7 @@ gem "pry"
 gem "timecop"
 gem "rubocop", require: false
 gem "steep", require: false
+gem 'typeprof', require: false
 gem 'rbs', require: false
 gem "sinatra", require: false
 gem "webrick", require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.1.16.1)
+    procon_bypass_man (0.1.19.1)
       action_cable_client
       pbmenv
       sorted_set
@@ -36,7 +36,7 @@ GEM
     parallel (1.21.0)
     parser (3.0.3.2)
       ast (~> 2.4.1)
-    pbmenv (0.1.7)
+    pbmenv (0.1.8)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -49,7 +49,7 @@ GEM
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rbs (1.7.1)
-    rbtree (0.4.4)
+    rbtree (0.4.5)
     regexp_parser (2.2.0)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -100,6 +100,8 @@ GEM
       unicode-display_width (>= 1.1.1, < 3)
     tilt (2.0.10)
     timecop (0.9.4)
+    typeprof (0.20.4)
+      rbs (>= 1.6.2)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
@@ -119,6 +121,7 @@ PLATFORMS
   arm64-darwin-20
   arm64-darwin-21
   armv7l-linux
+  ruby
   x86_64-linux
 
 DEPENDENCIES
@@ -131,6 +134,7 @@ DEPENDENCIES
   sinatra
   steep
   timecop
+  typeprof
   webrick
 
 BUNDLED WITH

data/README.md

@@ -1,18 +1,24 @@
 # ProconBypassMan
+<img src="https://user-images.githubusercontent.com/1664497/151661582-3a1e8ce9-6c38-4754-8075-7a4453b3109a.jpg" width="500px">
+
 [![Ruby](https://github.com/splaplapla/procon_bypass_man/actions/workflows/ruby.yml/badge.svg?branch=master)](https://github.com/splaplapla/procon_bypass_man/actions/workflows/ruby.yml)
 
-* Switchに繋いだプロコンを連射機にしたり、キーのリマップをしたり、マクロを実行できるツールです
+* Switchに繋いだプロコンを連射機にしたり、ボタンのリマップをしたり、マクロを実行できる、Raspberry Pi上で動かすツールです
     * 設定ファイルはrubyスクリプトで記述します
 * 特定のタイトルに特化した振る舞いにしたい時は各プラグインを使ってください
+* ドキュメントは [getting_started.md](docs/getting_started.md) にまとめています
 
 ![image](https://user-images.githubusercontent.com/1664497/123414210-942f6980-d5ee-11eb-8192-955bd9e37e0b.png)
 
+
+<!--
 ```
 @startuml
-ProController --> (PBM): ZR押しっぱなし
+ProController \-\-> (PBM): ZR押しっぱなし
 Switch <-- (PBM): ZR連打
 @enduml
 ```
+-->
 
 ## 使うハードウェア
 * プロコン
@@ -33,7 +39,7 @@ Switch <-- (PBM): ZR連打
     * sudo apt-get install rbenv
     * git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build
     * rbenv install 3.0.1
-  * sudo gem install pbmenv
+  * gem install pbmenv
   * sudo [pbmenv](https://github.com/splaplapla/pbmenv) install latest
 * Raspberry Pi4 でprocon_bypass_manを実行する
   * cd /usr/share/pbm/current
@@ -45,12 +51,15 @@ Switch <-- (PBM): ZR連打
 * https://github.com/splaplapla/procon_bypass_man-splatoon2
 
 ## 関連ソフトウェア
-* サーバソフトウェア(WIP)
+* procon_bypass_man_cloud
+  * webアプリケーション
   * https://github.com/splaplapla/procon_bypass_man_cloud
-  * このサーバからOS自体の再起動、設定ファイルの変更、PBMのバージョンアップができます
-  * 自分でホストティングしてください
+  * このwebアプリからOS自体の再起動、設定ファイルのバックアップ・変更、PBMのバージョンアップができます
+  * ご自身でホストティングもできますが、 私がホスティングをしている https://pbm-cloud.herokuapp.com を使うことができます
+      * [使い方](https://pbm-cloud.herokuapp.com/faq)
 * pbmenv
-  * バージョンマネージャー
+  * procon_bypass_manのバージョンマネージャー
+  * https://github.com/splaplapla/pbmenv
 
 ## FAQ
 * どうやって動かすの?
@@ -60,10 +69,11 @@ Switch <-- (PBM): ZR連打
 * ラズベリーパイ4のセットアップ方法は？
     * https://github.com/splaplapla/procon_bypass_man/tree/master/docs/setup_raspi.md
 * モード, マクロの違いは？
-    * modeはProconの入力をそのまま再現するため機能。レイヤーを切り替えるまで繰り返し続ける
-    * マクロは特定のキーを順番に入れていく機能。キーの入力が終わったらマクロは終了する
+    * modeはProconの入力をそのまま再現するため機能。レイヤーを切り替えるまで繰り返し続けます
+    * マクロは特定のキーを順番に入れていく機能。キーの入力が終わったらマクロは終了します
 * レイヤーとは？
-    * 自作キーボードみたいな感じでレイヤー毎に設定内容を記述して切り替えれる
+    * 自作キーボードみたいな感じでレイヤー毎に設定内容を記述して切り替えれます
+    * レイヤーは4つあって、up, down, left, rightです。十字キーに対応しています
 * レイヤーを切り替える方法は？
     * 設定ファイルに記述している `prefix_keys_for_changing_layer`の後ろにあるキーを同時押しながら、十字キーのどれかを押すことで任意のレイヤーに切り替わります
 * このツールでできることは？
@@ -71,18 +81,15 @@ Switch <-- (PBM): ZR連打
         * リマップは1つのキーを別のキーに割り当てます
     * 連射中には特定のキーの入力を無視したり、複数のキーをトリガーに連射することができます
 * どうしてsudoが必要なの？
-    * 操作するdeviceファイルの所有者がrootだから
+    * 操作するdeviceファイルの所有者がrootだからです
 * 市販されているサードパーティ製連射機との違いは？
-    * サードパーティ製のコントローラーは、設定方法や形状が特殊で買い換えるたびに学習・設定コストが発生します。本ツールを使えば、設定内容はテキストで管理することができ、使い慣れたプロコンで同等のことができます。
+    * サードパーティ製のコントローラーは、設定方法や形状が特殊で買い換えるたびに学習・設定コストが発生します。本ツールを使えば、設定内容はテキストで管理することができ、使い慣れたプロコンで同等のことができます
 * sshなしで運用は可能ですか？
-    * 後述するWEBアプリケーションを使えば、sshを使わずに運用が可能です
-        * https://github.com/splaplapla/procon_bypass_man_cloud
-    * 機能開発中ですが、使ってくれる人を探しているのでdiscordからお問合せください
+    * https://pbm-cloud.herokuapp.com を使えば、sshを使わずに運用が可能です
 
 ## TODO
 * レコーディング機能(プロコンの入力をマクロとして登録ができる)
-* マクロにdelayを入れれるようにする
-* 設定ファイル マクロの引数に、ボタンを取れるようにする
+* ドキュメントを書く(doing)
 
 ## 開発系
 ### プロコンとの接続を維持したまま、現在の設定ファイルをPBMに反映する
@@ -102,6 +109,7 @@ sudo kill -USR2 `cat ./pbm_pid`
 * project_template/web.rb, project_template/app.rb, lib/procon_bypass_man/version.rb のバージョンをあげる
 * CHANGELOG.md に日付を書く
 * be rake release
+* githubのreleaseを作成する
 
 ## License
 

data/Steepfile

@@ -1,15 +1,15 @@
 # D = Steep::Diagnostic
 #
 # target :lib do
-#   signature "sig"
+#   signature 'sig'
 #
-#   check "lib"                       # Directory name
-#   check "Gemfile"                   # File name
-#   check "app/models/**/*.rb"        # Glob
-#   # ignore "lib/templates/*.rb"
+#   check 'lib'                       # Directory name
+#   check 'Gemfile'                   # File name
+#   check 'app/models/**/*.rb'        # Glob
+#   # ignore 'lib/templates/*.rb'
 #
-#   # library "pathname", "set"       # Standard libraries
-#   # library "strong_json"           # Gems
+#   # library 'pathname', 'set'       # Standard libraries
+#   # library 'strong_json'           # Gems
 #
 #   # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
 #   # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
@@ -19,21 +19,35 @@
 # end
 
 # target :test do
-#   signature "sig", "sig-private"
+#   signature 'sig', 'sig-private'
 #
-#   check "test"
+#   check 'test'
 #
-#   # library "pathname", "set"       # Standard libraries
+#   # library 'pathname', 'set'       # Standard libraries
 # end
 
 target :lib do
-  check "lib/procon_bypass_man/timer.rb"
-  check "lib/procon_bypass_man/uptime.rb"
-  check "lib/procon_bypass_man/configuration.rb"
+  check 'lib/procon_bypass_man/timer.rb'
+  check 'lib/procon_bypass_man/configuration.rb'
+  check 'lib/procon_bypass_man/processor'
+  check 'lib/procon_bypass_man/procon/macro_registry'
+  check 'lib/procon_bypass_man/procon/mode_registry'
+  check 'lib/procon_bypass_man/domains/*'
+  check 'lib/procon_bypass_man/domains'
+  check 'lib/procon_bypass_man/support/report_http_client'
+  check 'lib/procon_bypass_man/support/http_client'
+  check 'lib/procon_bypass_man/support/send_device_stats_http_client'
+  check 'lib/procon_bypass_man/support/on_memory_cache'
+  check 'lib/procon_bypass_man/support/server_pool'
+  check 'lib/procon_bypass_man/support/uptime.rb'
+  check 'lib/procon_bypass_man/support/safe_timeout'
+  check 'lib/procon_bypass_man/support/update_remote_pbm_action_status_http_client'
+  check 'lib/procon_bypass_man/support/compress_array'
 
-  signature "sig"
+  signature 'sig'
 
-  library "time"
-  library "logger"
-  library "monitor"
+  library 'time'
+  library 'logger'
+  library 'monitor'
+  library 'uri'
 end

data/docs/getting_started.md

@@ -0,0 +1,60 @@
+# GETTING STARTED 
+## 目次
+* [はじめに](#はじめに)
+    * [procon_bypass_manで解決したいこと](#procon_bypass_manで解決したいこと)
+    * [procon_bypass_manでできること](#procon_bypass_manでできること)
+* [セットアップ](#セットアップ)
+  * ラズベリーパイのセットアップ
+  * procon_bypass_manのインストール
+      * pbmenvを使う方法
+      * pbmenvを使わない方法
+  * とりあえず動かす方法
+* [普段使いをするためのセットアップ](#普段使いをするためのセットアップ)
+* レイヤー
+* モード
+* マクロ
+* 左スティックの感度調整
+* 設定ファイルの書き方
+  * layer
+* プラグインの書き方
+* 設定ファイルの書き方がわからない、エラーが起きるとき
+* procon_bypass_man_cloudについて
+
+## はじめに
+### procon_bypass_manで解決したいこと
+
+通常、ボタン連射をするには、市販されているサードパーティー製のコントローラーを使う必要があるのですが、ボタンの押した感覚や各種設定方法は各社の独自仕様であるため、それらを手に馴染ませるのがとても大変です。  
+特に「説明書を熟読してコントローラーの設定方法を覚えること、設定されている状態を思い出す」がつらい。
+
+このツールを使うことで、使い慣れたコントローラーを使ってボタン連射ができます。また、設定内容はテキストで管理しているため一目瞭然です。
+
+### procon_bypass_manでできること
+* 設定内容を即時に入れ替え（レイヤー管理)
+* 連射
+  * 連射中は特定のキーの入力を無視したり、複数のキーをトリガーに連射することもできます
+* マクロ
+  * [活用例](/docs/setting/splatoon2_macro_sokuwari_bubble.md)
+* 特定の同じ操作の繰り返し(モード)
+* 左スティックの感度調整
+  * [設定方法](/docs/setting/left-analogstick-cap.md)
+* WEBから設定状態の閲覧・反映
+* ボタンリマップ
+
+## セットアップ
+* 後で書きます
+
+## 普段使いをするためのセットアップ
+
+procon_bypass_manを起動するだけでプロコンと接続ができるようになったら、Raspberry Piを起動したときにprocon_bypass_manも自動起動するように設定しましょう。  
+これを設定すると、Switch本体の電源ボタンを押すだけで使えるようになります。(実際には、Raspberry Piが起動して、procon_bypass_manが動き始めるまでに30秒くらいかかります。)
+
+自動起動方法は、pbmenvを使っているなら以下の2行をshellで実行すれば完了です。
+
+```
+sudo systemctl link /usr/share/pbm/current/systemd_units/pbm.service
+sudo systemctl enable pbm.service
+```
+
+pbmenvを使っていない場合は、 https://github.com/splaplapla/procon_bypass_man/blob/master/project_template/systemd_units/pbm.service をダウンロードして、 `systemctl link` をしてください。
+
+ゲームをやめたくなったらSwitchはそのままスリープに入って問題ないです。このときにRaspberry Piも一緒に電源が切れてしまいますが故障することはありません。

data/docs/setting/left-analogstick-cap.md

@@ -0,0 +1,60 @@
+# 左アナログスティック感度調整の設定方法
+https://user-images.githubusercontent.com/1664497/150636857-f3d40900-2713-41b8-856a-279c200d9ae7.mp4
+
+* procon_bypass_man: 0.1.9以上が必要です
+* PBMには、左アナログスティックの入力の最大値を書き換える機能があります。それをsetting.ymlに書く方法を説明します
+* これを使うと、特定のボタンを押している間は、スティックを完全に倒している状態で、スプラトゥーンでいうところの `スニーキング` で移動ができるようになります
+
+## 1. プロコンの左スティックのほぼニュートラルな状態の座標を記述する
+* `set_neutral_position x, y`を使って、プロコンの左スティックのほぼニュートラルな状態の座標を記述します
+  * 完全にニュートラルな値を記述すると最速のスニーキングが出ないので微妙にずらします
+* プロコンごとにニュートラルな状態の座標に個体差があって、最速のスニーキングを出すには本数値を調整する必要があります
+* 実際に設定している座標の例
+  * `set_neutral_position 1906, 1886`
+  * `set_neutral_position 2100, 2000`
+
+## 2. 左アナログスティックの入力の最大値を設定する
+* ニュートラルな状態の座標が決まったら、次はどのボタンを押したときに、どれくらいスティック感度を書き換えるか、を設定します
+* 設定には `left_analog_stick_cap` を使います
+* 実際にパラメータを記述した例を用いると `left_analog_stick_cap cap: 1100, if_pressed: [:zl, :a], force_neutral: :a` のようになります
+  * パラメータは3つあります
+    * `cap: 1100`
+      * こちらはニュートラル座標からの最大距離をどのくらいにするか、を決めます
+        * 指定したボタンが押されている間は、ニュートラル座標から1100までの範囲に「現在の座標」を書き換える、という設定になります
+        * スプラトゥーンのスニーキング用途であれば、1100固定で問題ありません
+    * `if_pressed: [:zl, :a]`
+      * こちらは zlボタン, aボタンが両方押されている状態の時に本設定が発動する、という設定になります。トリガーです
+        * つまり、zlとaを同時押ししている時に、左アナログスティックの入力を書き換えます
+    * `force_neutral: :a`
+      * こちらは、左アナログスティックの入力を書き換えている時は、「強制的にaボタンを押していない状態にする」という設定になります
+      * つまり、zlボタンとaボタンを同時押ししている時には、左アナログスティックの入力を書き換えて、aボタンは押していない状態になります
+        * どうしてこれが必要かというと、ゲームタイトルによるのですが、スプラトゥーンの場合は、ガチアサリ中に、保有しているアサリを投げないために必要になっています
+      * force_neutralはoptionalです
+
+## 3. 設定を反映させる
+* 上記の記述を加えたsetting.ymlを起動中のprocon_bypass_manプロセスで読み込むには、プロセスにその旨を伝える必要があります
+  * ラズベリーパイを再起動して、プロセスを立ち上げ直す、でも目的は達成できますが、もっと簡単にsetting.ymlを再読み込みする必要があります
+* 書き換えたsetting.ymlを、起動中のprocon_bypass_manプロセスへ即時反映するには、procon_bypass_manプロセスを動かしたまま、別のshellから 以下をを実行してください
+  * setting.ymlのシンタックスが正しければ、switchとの接続が継続したままsetting.ymlの内容を読み込んでいるはずです
+
+```shell
+sudo kill -USR2 `cat ./pbm_pid` 
+```
+
+## まとめ
+* スティックの中央値を設定します
+  * スプラトゥーンでの最速スニーキングを出すには、set_neutral_positionの値を変更してください
+* 発動するボタンを設定します
+* setting.ymlを再読み込みします
+
+## 設定例
+```yaml
+version: 1.0
+setting: |-
+  prefix_keys_for_changing_layer [:zr, :zl, :l]
+  set_neutral_position 2100, 2000
+
+  layer :up, mode: :manual do
+    left_analog_stick_cap cap: 1100, if_pressed: [:zl, :a], force_neutral: :a
+  end
+```

data/docs/setting/splatoon2_macro_sokuwari_bubble.md

@@ -0,0 +1,52 @@
+# スプラトゥーン2: バブル即割(スプラッシュボム)マクロの設定方法
+https://user-images.githubusercontent.com/1664497/152633205-ab44896b-9fa4-402c-b9aa-667e00676032.mp4
+
+* procon_bypass_man: 0.1.18以上が必要です
+* このマクロは、バブルの1個目のみを即割します
+
+## 1. install_macro_pluginで即割マクロを有効化します
+* `setting.yml` に`install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::SokuwariForSplashBomb` と書きます
+* これを記述することで、layer内で呼び出せるようになります
+
+## 2. どのlayerで発動するかを宣言します
+* `setting.yml` のlayer内に`macro ProconBypassMan::Plugin::Splatoon2::Macro::SokuwariForSplashBomb, if_pressed: [:zl, :right]` と書きます
+  * `if_pressed` がどのボタンを押したときにこのマクロが発動するかの設定です
+      * ここのオプションは、自由に変更可能です
+  * この場合は、ZLと十字キーの左を同時すると、このマクロが発動します
+
+## 3. 設定を反映させる
+* 上記の記述を加えたsetting.ymlを起動中のprocon_bypass_manプロセスで読み込むには、プロセスにその旨を伝える必要があります
+    * ラズベリーパイを再起動して、プロセスを立ち上げ直す、でも目的は達成できますが、もっと簡単にsetting.ymlを再読み込みする必要があります
+* 書き換えたsetting.ymlを、起動中のprocon_bypass_manプロセスへ即時反映するには、procon_bypass_manプロセスを動かしたまま、別のshellから 以下をを実行してください
+    * setting.ymlのシンタックスが正しければ、switchとの接続が継続したままsetting.ymlの内容を読み込んでいるはずです
+
+## まとめ
+*  次の2行の追加が必要です。
+    * `install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::SokuwariForSplashBomb`
+    * `macro ProconBypassMan::Plugin::Splatoon2::Macro::SokuwariForSplashBomb, if_pressed: [:zl, :right]`
+
+## 設定例1
+```yaml
+version: 1.0
+setting: |-
+  prefix_keys_for_changing_layer [:zr, :zl, :l]
+  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::SokuwariForSplashBomb
+
+  layer :up do
+    macro ProconBypassMan::Plugin::Splatoon2::Macro::SokuwariForSplashBomb, if_pressed: [:zl, :right]
+  end
+```
+
+## 設定例2
+* `open_macro` キーワードを使っても同じことが実行可能です。
+* この場合は、 `install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::SokuwariForSplashBomb` が不要です。
+
+```yaml
+version: 1.0
+setting: |-
+  prefix_keys_for_changing_layer [:zr, :zl, :l]
+
+  layer :up do
+    open_macro :sokuwari, steps: [:toggle_r_for_0_2sec, :toggle_thumbr_for_0_14sec, :toggle_thumbr_and_toggle_zr_for_0_34sec, :toggle_r_for_1sec], if_pressed: [:zl, :right]
+  end
+```

data/docs/setting/splatoon2_recommended_setting.md

@@ -0,0 +1,40 @@
+# スプラトゥーン2: おすすめの設定
+## 全般
+### 簡単スニーキング
+
+ボタンを押している間は、水飛沫のたたないスニーキングの感度まで調整することができます。  
+[設定方法](/docs/setting/left-analogstick-cap.md)
+
+### ナイス玉連打
+
+`flip :down, if_pressed: :down`  
+十字キーの下ボタンは常に連打にしておくとナイス玉が来たときに楽です。
+
+### マクロでスーパージャンプ
+
+```
+install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::FastReturn
+install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToUpKey
+install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToRightKey
+install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToLeftKey
+
+layer :up, mode: :manual do
+  macro ProconBypassMan::Plugin::Splatoon2::Macro::FastReturn, if_pressed: [:y, :b, :down]
+  macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToUpKey, if_pressed: [:y, :b, :up]
+  macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToRightKey, if_pressed: [:y, :b, :right]
+  macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToLeftKey, if_pressed: [:y, :b, :left]
+end
+```
+
+リスポーンや味方にスーパージャンプするマクロがあります。トリガーは自由に設定できます。
+
+## 武器に特化した設定
+### パブロ向け
+
+`flip :zr, if_pressed: :zr, force_neutral: :zl`  
+zrを連打にします。`force_neutral: :zl` というオプションをつけることで、ZRを押している間はZLを押しても無視されるようになります。パブロでは意味がありませんが、シューターだと煽りのような動作を抑制することができます。
+
+### ボトルガイザー(フォイル)向け
+
+バブル即割のマクロがあります。
+[設定方法](/docs/setting/splatoon2_macro_sokuwari_bubble.md)