Skip to content

Repository files navigation

Coding BGM 🎵

VS Code の中で、集中力を高める環境BGMの再生とポモドーロタイマーを使える拡張機能です。 A VS Code extension integrating ambient background music and a Pomodoro timer for focused coding sessions.


🇯🇵 日本語のドキュメントを表示 (Click to expand)

概要

『Coding BGM』は、プログラミングや作業に深く没頭するために開発された、VS Code(Visual Studio Code)専用の拡張機能です。 音楽ファイルなどを読み込む必要がなく、拡張機能内で直接、心地よい環境音を生成して再生します。また、作業と休憩のサイクルを作るポモドーロタイマーも搭載しています。

主な特徴・機能

  • 🎵 7種類の環境音(BGM): Lo-Fiビート、雨の音、カフェの雑踏、静かな森、波の音、ホワイトノイズ、暖炉の薪がはぜる音など、好みに合わせた音が選べます。
  • ⏱️ ポモドーロタイマー機能: 集中時間(デフォルト25分)と休憩時間(デフォルト5分)を管理し、作業の効率を高めます(時間は設定で自由に変更可能です)。
  • 📊 音の視覚化(オーディオビジュアライザー): 再生中の音に合わせて波形が動く、リアルタイムの周波数ビジュアライザーがプレイヤー画面に表示されます。
  • 📌 ステータスバーからの簡単操作: VS Codeのステータスバー(画面下部)に、再生/一時停止ボタン、現在のBGM名、タイマーが常時表示され、エディタを閉じずに操作できます。
  • ⌨️ ショートカットキー対応: キーボードの Ctrl + Alt + M を押すだけで、いつでもBGMの再生と一時停止を切り替えられます。

使い方・操作

  • プレイヤーを開く:コマンドパレット (Ctrl + Shift + P) から Coding BGM: Open Player を選択
  • 再生 / 一時停止Ctrl + Alt + M または ステータスバーのBGM表示をクリック
  • BGMの変更:ステータスバーの音源名をクリック、またはプレイヤー画面で選択
  • タイマー開始:ステータスバーのタイマー表示をクリック、またはプレイヤー画面で操作
🇺🇸 Show English Document (Click to expand)

Overview

"Coding BGM" is a VS Code extension designed to help you submerge into deep focus while programming. It provides high-quality ambient background sounds generated dynamically inside your editor, combined with a built-in Pomodoro timer.

Key Features

  • 🎵 7 Ambient Sounds: Choose from Lo-Fi beats (with vinyl crackle), Gentle Rain, Cozy Café, Quiet Forest, Rolling Ocean, White Noise, and Warm Fireplace.
  • ⏱️ Integrated Pomodoro Timer: Keeps track of your focus sessions (default: 25 mins) and breaks (default: 5 mins) to maximize productivity. Times are fully configurable.
  • 📊 Real-time Audio Visualizer: Displays a frequency wave animation in the player panel that reacts dynamically to the playing sound.
  • 📌 Status Bar Quick Controls: Always visible controls on your status bar (bottom of VS Code) displaying play/pause button, the current sound name, and the active timer.
  • ⌨️ Hotkey Toggle: Press Ctrl + Alt + M to quickly play or pause your background music instantly.

How to Use / Controls

  • Open Player: Search Coding BGM: Open Player in the Command Palette (Ctrl + Shift + P).
  • Play / Pause: Press Ctrl + Alt + M or click the BGM icon on the status bar.
  • Change Sound: Click the active sound name on the status bar, or choose from the player panel.
  • Start Timer: Click the timer display on the status bar, or manage it via the player panel.

About

🎵 VS Code extension for ambient background music & Pomodoro timer. Play Lo-Fi, Rain, Café, Forest, Ocean sounds — all generated with Web Audio API. No audio files needed.

Topics

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages