Skip to content

readme.md

Latest commit

 

History

History
96 lines (79 loc) · 4.55 KB

readme.md

File metadata and controls

96 lines (79 loc) · 4.55 KB

満腹じゃんけん CLI / Calorie Clash CLI

ポイントを稼ぐか、満腹で脱落か──胃袋の限界バトル。

概要 / Overview

Python 製の CLI ゲームです。1P（vs CPU）/ 2P（vs Player）、カスタムルール（目標ポイント、満腹度容量、あいこ時挙動）、入力モード（g/c/p 直入力 or questionary による選択メニュー）に対応。 Rich による色付き出力で視認性を高めています。

インストール / Install

python -m venv .venv && source .venv/bin/activate  # Windows: .venv\\Scripts\\activate
pip install -e .

実行 / Run

# 引数なしで実行（タイトル画面 → スタート/オプション/終了）
calorie-clash

# 2P 対戦（両者とも人間）
calorie-clash --mode 2p

# questionary による選択メニュー入力
calorie-clash --mode 1p --input menu

# セットアップウィザードで起動（モード/体格/タイールール等を対話設定）
calorie-clash --wizard

# インストールせずに実行（開発時）
PYTHONPATH=src python -m calorie_clash --mode 1p  # Windows: $env:PYTHONPATH="src"; python -m calorie_clash --mode 1p

テスト / Test

（任意）pytest を導入後に追加予定です。

メニューで使えるコマンド

  • :help ヘルプ表示
  • :status 現在のスコア/満腹度を表示
  • :rules 現在のルールを表示
  • :set key=value ルール変更（input=direct|menu, time=秒, tie=replay|bothEat|skip, target=数, capacity=数, multiplier=数）
  • :quit 終了

アニメーション / 確認

  • 決定確認: 双方の手の選択後に「決定/やり直し」を確認
  • ジャン・ケン・ポン！: 1秒刻みで表示（ジャン → ケン → ポン！）

キーボード操作（メニュー）

  • 選択メニュー: ↑/↓ で移動、Enter で決定、^C でキャンセル
  • チェックボックス: ↑/↓ で移動、Space で切替、Enter で適用、^C でキャンセル

タイトル/オプション

  • タイトル: 「ゲームスタート」「オプション」「終了」
  • オプション:
    • 言語設定（ja/en）
    • ルール設定（チェックボックス）
      • あいこ時に両者食べる（bothEat）
      • 入力方式を選択メニュー（questionary）にする
    • カーソル表示（選択）
      • ❯ / > / 👉 から選択可
    • 色設定（選択）
      • カーソル色（pointer color）
      • 選択中の下線色（highlight underline color）
    • 食べ物CSVの読み込み
      • hand,name,kcal[,points] のCSVを読み込み
      • 適用方法を選択: 既定に追加（extend）/ 既定を置換（replace）
      • points 列があればポイント計算を上書き（無い場合は名前長×2）

仕組み / Architecture

  • コア型/データ: src/calorie_clash/core/types.py, src/calorie_clash/core/data.py
  • ゲームロジック: src/calorie_clash/core/engine.py
  • CLI入出力/進行: src/calorie_clash/cli/loop.py
  • セットアップウィザード: src/calorie_clash/cli/wizard.py
  • タイトル/オプション: src/calorie_clash/cli/title.py
  • エントリ: src/calorie_clash/cli/main.py / src/calorie_clash/__main__.py
  • コンソール（色テーマ）: src/calorie_clash/cli/console.py

MIT License

主要オプション

  • --mode: 1p | 2p
  • --input: direct | menu（questionary）
  • --target: 目標ポイント（既定 50）
  • --physique: small | medium | large（満腹上限 800/1000/1300）
  • --p1-name, --p2-name: プレイヤー名
  • --tie: rematch | bothEat（あいこ時の挙動）
  • --wizard: 起動時にセットアップウィザードを実行
  • --anim: on | off（ジャン・ケン・ポンのアニメーション表示）
  • --anim-speed: アニメ間隔（秒, 既定 1.0）
  • --pointer: tri | gt | hand（メニューのカーソル記号: tri=❯, gt=>, hand=👉）
  • --pointer-color: magenta|cyan|green|yellow|blue|white
  • --underline-color: cyan|magenta|green|yellow|blue|white
  • --foods-csv: 食べ物CSVのパス（hand,name,kcal[,points]）
  • --foods-mode: extend | replace（CSVの適用方法）

プロジェクト管理 / Project Management

このリポジトリでは GitHub Actions によってプロジェクトボードを自動生成します。新規リポジトリ作成時に "📋 Project Tasks" プロジェクトと "To Do", "In Progress", "Done" のカラムが作成され、Issue が作成されると "To Do" カラムへカードとして追加されます。