Skip to content

Latest commit

 

History

History
158 lines (107 loc) · 7.49 KB

File metadata and controls

158 lines (107 loc) · 7.49 KB

한국어 | English | 中文

dmnote Logo

DM Note

Key viewer program with extensive customization support

Offers user-defined key mapping and styling, easily switchable presets, and a modern, intuitive interface.

GitHub release GitHub downloads GitHub license

demo.mp4

🌟 Overview

DM Note is a key viewer program optimized for DJMAX RESPECT V, and can be freely used with any other game. With simple setup, you can visually display key inputs during streaming or gameplay video creation. Currently, it officially supports Windows 10/11 and macOS environments only. If you are on Linux, we recommend trying the community fork version.

Download DM NOTE v1.6.0

🖼️ Screenshots

Screenshot

Note Effect

✨ Features

⌨️ Keyboard Input & Mapping

  • Real-time keyboard input detection and visualization
  • Custom key mapping configuration

🎨 Key Style Customization

  • Grid-based key editing
  • Support for image assignment

🌧️ Note Effect (Raining Effect) Customization

  • Note effect style customization
  • Track speed, height, and reverse mode support

🔢 Key Counter

  • Display input counts per key
  • Customize counter position, color, and style

📊 Input Statistics

  • KPS, AVG, MAX, TOTAL statistics display
  • KPS graph visualization
  • Statistics elements and graph style customization

🎵 Key Sound

  • Play sound effects on key input
  • Custom sound file support

🖼️ Overlay & Window Management

  • Lock window position & always on top
  • Select resize anchor

🖥️ OBS Mode

  • Compatible with OBS browser source

🧩 Custom CSS & Plugin Support

  • Fully customizable program interface and overlay styles with custom CSS
  • Custom plugin support

💾 Presets & Settings Management

  • Auto-save user settings
  • Save/Load presets

⚙️ Other Settings

  • Multilingual interface support (Korean, English, Chinese Simplified/Traditional, Russian)
  • Shortcut key settings support
  • Reset settings and auto-update

🚀 Development

Tech Stack

  • Frontend: React 19 + Typescript + Vite 7
  • Backend: Tauri
  • Styling: Tailwind CSS 3
  • Input Detection: Raw Input API (Windows), Global input events (macOS)
  • Package Manager: npm

Basic Installation & Run

Enter the following commands in your terminal in order:

git clone https://github.com/lee-sihun/DmNote.git
cd DmNote
npm install
npm run tauri:dev

� Notes

  • This program is free to use for streaming or gameplay video production.
  • macOS installation and permission setup guide
  • Program default settings are saved in the %appdata%/com.dmnote.desktop folder.
  • If you don't need to check the overlay in real-time and are using it for streaming or gameplay video production, OBS Mode is recommended by default. This can reduce the negative impact on game frame rates compared to the regular overlay mode.
  • If your gaming PC and streaming/recording PC are separate, we recommend running DM Note on the gaming PC and connecting via OBS browser source on the streaming/recording PC. This can almost completely resolve game frame drop issues caused by the key viewer.
  • Even with the Always on top feature enabled, the overlay may be hidden behind the game in full-screen mode for some games. In this case, please use borderless window mode.
  • Official plugins and CSS example files are included in the assets.zip file.
  • Never load untrusted plugins. When using unofficial plugins, make sure to verify their safety using tools like ChatGPT before use.
  • When assigning class names, enter only the name excluding the selector (blue ✅, .blue ❌)

🤝 Contributing

We welcome your contributions! Please check the Contributing Guide for details.

✨ Contributors

이시훈
이시훈

🚧
연우
연우

🎨 🤔
mo_hong
mo_hong

🌍
LSVoiid
LSVoiid

🌍 📖
문주
문주

💻
dustingusius
dustingusius

🌍
Dotoritos
Dotoritos

💻

📄 License

GPL-3.0 License Copyright (C) 2024 lee-sihun

❤️ Special Thanks!