procon_bypass_man 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4e92960c4a8756b58054f9ed64d27ac2a59917371781b4299a88e9a26502075
-  data.tar.gz: 34e839eb78c1c1d0674291112c2c7c4a5d9be5ae026df60e3ac66395d52927a1
+  metadata.gz: f0ba281c9129f770b6cf905d9221bc39de1957f33d0091e2a5217c1fb4547be8
+  data.tar.gz: ca0fbffd26fb3a7ad928803ea912a1fe6412a4b8d10a65acefbc21d0fe2f0b49
 SHA512:
-  metadata.gz: 6c16bde4afb251d833d7bf411c8521566027d4109fcd654992b004c336735b1c8f4c6f97441cf99f728d06808cdd9b6d43f73bc527081b9c8d9059fd89893fa3
-  data.tar.gz: bd1ef2643d015a4e80d233a2493d1dcc80c871a958b9551b3691b31cdddefbbfef64e5a61b2fff3737186e064ce39cfe0cce310085c4cbb96c51fcf85be7b761
+  metadata.gz: 0425a0610a7ec5d583724a167f45eaf8f352d552f4158901d02138dbfe89a5b66972f7767c72eab7ed30c6b199af25db10a1c9ef1fb826c188fc30255e81ea98
+  data.tar.gz: 271542b52dce9d7b0980fb5f97c4fbab80b8fa9f03fc726dbf5034899d8a4f7a7cbdc10456a6016bcc81c038d8f0f3463a732d4a4cf7f4940b2ab652d0125d58

data/.circleci/config.yml

@@ -0,0 +1,20 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.1.2 
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:3.0.1
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: install bundler
+          command: gem install bundler:2.2.20
+      - run:
+          name: bundle install
+          command: bundle install --jobs 4
+      - run:
+          name: run test
+          command: bundle exec rspec

data/CHANGELOG.md

@@ -1,12 +1,14 @@
-## [0.1.2]
-- features
-  - 設定ファイルのライブリロードができるようになった
-  - 設定ファイルのバリデーションエラーとシンタックスエラーを投げるようになった
-  - key remap
-- breking changes
-    - 設定情報をyamlで書くようになった
+## [0.1.3] - 2021-07-03
+- 接続のしやすさ向上
 
-## [0.1.1]
+## [0.1.2] - 2021-06-25
+- 設定ファイルのライブリロードができるようになった
+  - tmp/pidにUSR2シグナルを送信すると設定を再読み込みする
+- 設定ファイルのバリデーションエラーとシンタックスエラーを投げるようになった
+- Support key remap
+- 設定情報をyamlで書くようになった
+
+## [0.1.1] - 2021-06-19
 - プロコンの出力をLoggerに書き出す
 - コマンドの標準出力にstatsを出す
 - graceful shutdown

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.1.2)
+    procon_bypass_man (0.1.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,12 +1,21 @@
 # ProconBypassMan
-* プロコンを連射機にしたり、マクロを実行できるツールです
+* Switchに繋いだプロコンを連射機にしたり、キーのリマップをしたり、マクロを実行できるツールです
     * 設定ファイルはrubyスクリプトで記述します
 * 特定のタイトルに特化した振る舞いにしたい時は各プラグインを使ってください
 
+![image](https://user-images.githubusercontent.com/1664497/123414210-942f6980-d5ee-11eb-8192-955bd9e37e0b.png)
+
+```
+@startuml
+ProController --> (PBM): ZR押しっぱなし
+Switch <-- (PBM): ZR連打
+@enduml
+```
+
 ## 使うハードウェア
 * プロコン
 * Switch本体とドック
-* Raspberry Pi4
+* Raspberry Pi4 Model B/4GB(Raspberry Pi OS (32-bit))
     * 他のシリーズは未確認です
 * データ通信が可能なUSBケーブル
 
@@ -15,101 +24,15 @@
   * ruby-3.0.x
 
 ## Usage
-* 以下のファイルを用意して`sudo`をつけて実行してください
-    * ex) `sudo bin/run.rb`
-
-```ruby
-# bundler inline
-require 'bundler/inline'
-
-gemfile do
-  gem 'procon_bypass_man', github: 'splaspla-hacker/procon_bypass_man', branch: "0.1.1"
-end
-
-ProconBypassMan.run(setting_path: "./setting.yml")
-```
-
-setting.yml
-
-```yml
-version: 1.0
-setting: |-
-  prefix_keys_for_changing_layer [:zr, :r, :zl, :l]
-  layer :up do
-    flip :zr, if_pressed: :zr
-    flip :zl, if_pressed: [:y, :b, :zl]
-    flip :down, if_pressed: true
-  end
-  layer :right do
-  end
-  layer :left
-  layer :down do
-    flip :zl, if_pressed: true
-    remap :l, to: :zr
-  end
-```
-
-### プラグインを使った設定例
-```ruby
-#!/usr/bin/env ruby
-
-require 'bundler/inline'
-
-gemfile do
-  gem 'procon_bypass_man', github: 'splaspla-hacker/procon_bypass_man', branch: "0.1.1"
-  gem 'procon_bypass_man-splatoon2', github: 'splaspla-hacker/procon_bypass_man-splatoon2', branch: "0.1.0"
-end
-
-ProconBypassMan.run(setting_path: "./setting.yml")
-```
-setting.yml
-
-```yml
-version: 1.0
-setting: |-
-  fast_return = ProconBypassMan::Splatoon2::Macro::FastReturn
-  guruguru = ProconBypassMan::Splatoon2::Mode::Guruguru
-
-  install_macro_plugin fast_return
-  install_mode_plugin guruguru
-
-  prefix_keys_for_changing_layer [:zr, :r, :zl, :l]
-
-  layer :up, mode: :manual do
-    flip :zr, if_pressed: :zr, force_neutral: :zl
-    flip :zl, if_pressed: [:y, :b, :zl]
-    flip :down, if_pressed: :down
-    macro fast_return.name, if_pressed: [:y, :b, :down]
-  end
-  layer :right, mode: guruguru.name
-  layer :left do
-    # no-op
-  end
-  layer :down do
-    flip :zl
-  end
-```
-
-* 設定ファイルの例
-  * https://github.com/jiikko/procon_bypass_man_sample
+* USBガジェットモードで起動するRaspberry Pi4を用意する
+  * https://github.com/splaspla-hacker/procon_bypass_man/blob/master/docs/setup_raspi.md
+* Raspberry Pi4で https://github.com/jiikko/procon_bypass_man_sample をclone して実行ファイルを動かす
+  * 実行ファイルと設定ファイルについては https://github.com/splaspla-hacker/procon_bypass_man/wiki に詳細を書いていますが、まず動かすためにはcloneしたほうが早いです
 
 ## Plugins
 * https://github.com/splaspla-hacker/procon_bypass_man-splatoon2
 
-## プラグインの作り方
-https://github.com/splaspla-hacker/procon_bypass_man-splatoon2 を見てみてください
-
-### モード
-* name, binariesの持つオブジェクトを定義してください
-* binariesには、Proconが出力するバイナリに対して16進数化した文字列を配列で定義してください
-
-### マクロ
-* name, stepsの持つメソッドをオブジェクトを定義してください
-* stepsには、プロコンで入力ができるキーを配列で定義してください
-  * 現在はintervalは設定できません
-
 ## FAQ
-### ソフトウェアについて
 * どうやって動かすの?
     * このツールはRaspberry Pi4をUSBガジェットモードで起動して有線でプロコンとSwitchに接続して使います
 * どうやって使うの？
@@ -121,37 +44,33 @@ https://github.com/splaspla-hacker/procon_bypass_man-splatoon2 を見てみて
     * マクロは特定のキーを順番に入れていく機能。キーの入力が終わったらマクロは終了する
 * レイヤーとは？
     * 自作キーボードみたいな感じでレイヤー毎に設定内容を記述して切り替えれる
+* このツールでできることは？
+    * キーリマップ, 連射, マクロ, 特定の同じ操作の繰り返し(mode)
+        * リマップは1つのキーを別のキーに割り当てます
+    * 連射中には特定のキーの入力を無視したり、複数のキーをトリガーに連射することができます
+* どうしてsudoが必要なの？
+    * 操作するdeviceファイルの所有者がrootだから
 
 ## TODO
-* ログをfluentdへ送信
 * 設定ファイルをwebから反映できる
-* ケーブルの抜き差しなし再接続(厳しい)
-    * 接続確立後、プロセスを強制停止し、接続したままプロセスを再起動すると、USBの経由での接続ができなくなる
-        * ケーブルを抜いてからリトライすると改善する
-        * ケーブルで繋がっているけどswitchとプロコンがBluetoothで繋がっている状態かつ非充電状態だとバイパスができない、ということがわかった
-    * ラズパイとプロコン間でBluetooth接続できれば解決するかもしれない
-        * ジャイロの入力を取る方法がまだ発見できていないらしく厳しいことがわかった
-            * https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/issues/7
-        * それとSwitchOS 12からペアリングの仕様に変更があって類似ツールが動かなくっている
 * ラズパイのプロビジョニングを楽にしたい
 * レコーディング機能(プロコンの入力をマクロとして登録ができる)
-* swtichとの接続完了はIOを見て判断する
 * webページから設定ファイルを変更できるようにする(sshしたくない)
     * webサーバのデーモンとPBMはプロセスを分ける(NOTE)
-* プロセスを停止するときにtmp/pidを削除する
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/procon_bypass_man. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/procon_bypass_man/blob/master/CODE_OF_CONDUCT.md).
 
-### ロギング
-```
+## 開発系
+```ruby
 ProconBypassMan.tap do |pbm|
-  pbm.logger = STDOUT
+  pbm.logger = Logger.new("#{ProconBypassMan.root}/app.log", 5, 1024 * 1024 * 10)
   pbm.logger.level = :debug
 end
 ```
 
+### プロコンとの接続を維持したまま、現在の設定ファイルをPBMに反映する
+```shell
+sudo kill -USR2 `cat ./pbm_pid`
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/docs/setup_raspi.md

@@ -1,5 +1,5 @@
 # Raspberry Pi4のセットアップ手順
-* SDカードに焼く
+* SDカードにRaspberry Pi OS (32-bit)を焼く
 * SDカードをRaspberry Pi4本体に挿して起動する
 * ラズパイGUI
   * 無線LANに接続する
@@ -36,3 +36,6 @@
 * cd ~ && mkdir -p src && cd ~/src && git clone https://github.com/jiikko/procon_bypass_man_sample && cd procon_bypass_man && sudo bundle install
 
 おわり. 起動する時は都度sudo ruby app.rb を実行する
+
+## 参考
+* https://mtosak-tech.hatenablog.jp/entry/2020/08/22/114622

data/examples/pbm.service

@@ -0,0 +1,27 @@
+# sudo ln -s /home/pi/src/procon_bypass_man/examples/pbm.service /etc/systemd/system/pbm.service
+# Usage:
+#   systemctl daemon-reload
+#   systemctl enable pbm.service
+#   systemctl start pbm.service
+#   systemctl status pbm.service
+#   systemctl restart pbm.service
+# Debug:
+#   journalctl -xe -f
+# TODO:
+#   do not make PIDFILE
+
+[Unit]
+Description=PBM
+# After=network-online.target
+After=network.target
+
+[Service]
+Type=simple
+# PIDFile=/home/pi/src/procon_bypass_man/pbm_pid
+# WatchdogSec=60
+WorkingDirectory=/home/pi/src/procon_bypass_man
+ExecStart=/home/pi/.rbenv/versions/3.0.1/bin/ruby examples/practical/app.rb
+Restart=always
+
+[Install]
+WantedBy=multi-user.target

data/examples/practical/app.rb

@@ -1,5 +1,9 @@
 #!/usr/bin/env ruby
 
+# sudo ln -s /home/pi/src/procon_bypass_man/examples/practical/setting.yml /home/pi/src/procon_bypass_man/setting.yml
+# cd src/procon_bypass_man
+# sudo ruby examples/practical/app.rb
+
 require 'bundler/inline'
 
 gemfile do
@@ -9,7 +13,7 @@ gemfile do
 end
 
 ProconBypassMan.tap do |pbm|
-  pbm.logger = "./app.log"
+  pbm.logger = Logger.new("#{ProconBypassMan.root}/app.log", 5, 1024 * 1024 * 10) # 5世代まで残して, 10MBでローテーション
   pbm.logger.level = :debug
 end
 

data/lib/procon_bypass_man.rb

@@ -1,5 +1,6 @@
 require "logger"
 require 'yaml'
+require "fileutils"
 
 require_relative "procon_bypass_man/version"
 require_relative "procon_bypass_man/device_registry"
@@ -16,7 +17,7 @@ Thread.abort_on_exception = true
 module ProconBypassMan
   class ProConRejected < StandardError; end
   class CouldNotLoadConfigError < StandardError; end
-  class CouldNotConnectDeviceError < StandardError; end
+  class FirstConnectionError < StandardError; end
 
   def self.configure(setting_path: nil, &block)
     unless setting_path
@@ -32,20 +33,21 @@ module ProconBypassMan
 
   def self.run(setting_path: nil, &block)
     configure(setting_path: setting_path, &block)
+    at_exit { FileUtils.rm_rf(pid_path) }
+    File.write(pid_path, $$)
     registry = ProconBypassMan::DeviceRegistry.new
     Runner.new(gadget: registry.gadget, procon: registry.procon).run
   rescue CouldNotLoadConfigError
     ProconBypassMan.logger.error "設定ファイルが不正です。設定ファイルの読み込みに失敗しました"
     puts "設定ファイルが不正です。設定ファイルの読み込みに失敗しました"
     exit 1
-  rescue CouldNotConnectDeviceError
-    ProconBypassMan.logger.error "デバイスと接続中です"
-    puts "デバイスと接続中です"
+  rescue FirstConnectionError
+    puts "接続を確立できませんでした。やりなおします。"
     retry
   end
 
-  def self.logger=(dev)
-    @@logger = Logger.new(dev, 5, 1024 * 1024 * 10) # 5世代まで残して, 10MBでローテーション
+  def self.logger=(logger)
+    @@logger = logger
   end
 
   def self.logger
@@ -56,6 +58,11 @@ module ProconBypassMan
     end
   end
 
+  DEFAULT_PID_PATH = File.expand_path('../pbm_pid', __dir__).freeze
+  def self.pid_path
+    @@pid_path ||= DEFAULT_PID_PATH
+  end
+
   def self.reset!
     ProconBypassMan::Procon::MacroRegistry.reset!
     ProconBypassMan::Procon::ModeRegistry.reset!
@@ -63,4 +70,8 @@ module ProconBypassMan
     ProconBypassMan::Configuration.instance.reset!
     ProconBypassMan::IOMonitor.reset!
   end
+
+  def self.root
+    File.expand_path('..', __dir__).freeze
+  end
 end

data/lib/procon_bypass_man/device_registry.rb

@@ -34,6 +34,7 @@ class ProconBypassMan::DeviceRegistry
         break
       else
         puts "プロコンをラズベイに挿してください"
+        ProconBypassMan.logger.info("プロコンをラズベイに挿してください")
         sleep(1)
       end
     end

data/lib/procon_bypass_man/io_monitor.rb

@@ -10,7 +10,6 @@ module ProconBypassMan
 
     # アクティブなバケットは1つだけ
     def record(event_name)
-      return unless $is_stable
       key = Time.now.strftime("%S").to_i
       if table[key].nil?
         self.previous_table = table.values.first
@@ -58,13 +57,6 @@ module ProconBypassMan
             next
           end
 
-          s_to_p = list.detect { |x| x.label == "switch -> procon" }
-          previous_table = s_to_p&.previous_table.dup
-          if previous_table && previous_table.dig(:eagain_wait_readable_on_read) && previous_table.dig(:eagain_wait_readable_on_read) > 300
-            # ProconBypassMan.logger.debug { "接続の確立ができません" }
-            # Process.kill("USR1", Process.ppid)
-          end
-
           line = list.map { |counter|
             "#{counter.label}(#{counter.formated_previous_table})"
           }.join(", ")

data/lib/procon_bypass_man/runner.rb

@@ -2,7 +2,6 @@ require_relative "io_monitor"
 
 class ProconBypassMan::Runner
   class InterruptForRestart < StandardError; end
-  class InterruptForCouldNotConnect < StandardError; end
 
   def initialize(gadget: , procon: )
     @gadget = gadget
@@ -14,7 +13,7 @@ class ProconBypassMan::Runner
 
   def run
     first_negotiation
-    $is_stable = false
+    print_booted_message
 
     self_read, self_write = IO.pipe
     %w(TERM INT USR1 USR2).each do |sig|
@@ -27,9 +26,6 @@ class ProconBypassMan::Runner
       end
     end
 
-    FileUtils.mkdir_p "tmp"
-    File.write "tmp/pid", $$
-
     loop do
       $will_terminate_token = false
       main_loop_pid = fork { main_loop }
@@ -39,11 +35,6 @@ class ProconBypassMan::Runner
           signal = readable_io.first[0].gets.strip
           handle_signal(signal)
         end
-      rescue InterruptForCouldNotConnect
-        $will_terminate_token = true
-        Process.kill("TERM", main_loop_pid)
-        Process.wait
-        raise ProconBypassMan::CouldNotConnectDeviceError
       rescue InterruptForRestart
         $will_terminate_token = true
         Process.kill("TERM", main_loop_pid)
@@ -72,10 +63,9 @@ class ProconBypassMan::Runner
   def main_loop
     # TODO 接続確立完了をswitchを読み取るようにして、この暫定で接続完了sleepを消す
     Thread.new do
-      sleep(10)
+      sleep(5)
       $will_interval_0_0_0_5 = 0.005
       $will_interval_1_6 = 1.6
-      $is_stable = true
     end
 
     ProconBypassMan::IOMonitor.start!
@@ -155,17 +145,46 @@ class ProconBypassMan::Runner
       rescue IO::EAGAINWaitReadable
       end
     end
+
+    # ...
+    #   switch) 8001
+    #   procon) 8101
+    #   switch) 8002
+    # が返ってくるプロトコルがあって、これができていないならやり直す
+    loop do
+      begin
+        data = @procon.read_nonblock(128)
+        if data[0] == "\x81".b && data[1] == "\x01".b
+          ProconBypassMan.logger.debug { "接続を確認しました" }
+          @gadget.write_nonblock(data)
+          break
+        else
+          raise ::ProconBypassMan::FirstConnectionError
+        end
+      rescue IO::EAGAINWaitReadable
+      end
+    end
   end
 
   def handle_signal(sig)
     ProconBypassMan.logger.info "#{$$}で#{sig}を受け取りました"
     case sig
-    when 'USR1'
-      raise InterruptForCouldNotConnect
     when 'USR2'
       raise InterruptForRestart
     when 'INT', 'TERM'
       raise Interrupt
     end
   end
+
+  # @return [void]
+  def print_booted_message
+    booted_message = <<~EOF
+      ProconBypassMan: #{ProconBypassMan::VERSION}
+      pid_path: #{ProconBypassMan.pid_path}
+      pid: #{$$}
+      project_path: #{ProconBypassMan.root}
+    EOF
+    ProconBypassMan.logger.info(booted_message)
+    puts booted_message
+  end
 end

data/lib/procon_bypass_man/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProconBypassMan
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/procon_bypass_man.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["jiikko"]
   spec.email         = ["n905i.1214@gmail.com"]
 
-  spec.summary       = "rasberrypi's software for procon"
+  spec.summary       = "extension for Nintendo Switch Pro Controller"
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/splaspla-hacker/procon_bypass_man"
   spec.license       = "MIT"

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: procon_bypass_man
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - jiikko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-26 00:00:00.000000000 Z
+date: 2021-07-03 00:00:00.000000000 Z
 dependencies: []
-description: rasberrypi's software for procon
+description: extension for Nintendo Switch Pro Controller
 email:
 - n905i.1214@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -31,6 +31,7 @@ files:
 - bin/setup
 - docs/how_to_connect_procon.md
 - docs/setup_raspi.md
+- examples/pbm.service
 - examples/practical/app.rb
 - examples/practical/setting.yml
 - examples/simple.rb
@@ -78,5 +79,5 @@ requirements: []
 rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
-summary: rasberrypi's software for procon
+summary: extension for Nintendo Switch Pro Controller
 test_files: []

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at n905i.1214@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.