Skip to content

northernorca/DmNote

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,026 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

한국어 | English | 中文

dmnote Logo

DM Note

다양한 커스터마이징을 지원하는 키뷰어 프로그램

사용자 정의 키 매핑과 스타일링, 손쉽게 전환 가능한 프리셋, 모던하고 직관적인 인터페이스를 제공합니다.

GitHub release GitHub downloads GitHub license

demo.mp4

🌟 개요

DM Note는 DJMAX RESPECT V에서 사용하기 위해 만들어진 키뷰어 프로그램입니다. 다른 게임에서도 자유롭게 사용할 수 있으며 간편한 설정으로 스트리밍이나 플레이 영상 제작 시 키 입력을 시각적으로 보여줄 수 있습니다. 현재는 공식적으로 Windows 10/11, macOS 환경만 지원하고 있습니다. 만약 리눅스 환경이라면 커뮤니티 포크 버전을 사용해보는걸 추천합니다.

본 레포지토리는 DM Note를 Linux에도 사용할 수 있도록 구현하는 프로젝트입니다.

DM NOTE for Linux 다운로드

설치 및 실행

Ubuntu, Debian 등 APT 기반 배포판

Release 탭에서 .deb 파일을 다운받아 실행합니다.

Fedora, RHEL 등 RPM 기반 배포판

Release 탭에서 .rpm 파일을 다운받아 실행합니다.

Arch, Cachy, Endeavour 등 pacman 기반 배포판

DM NOTE for Linux는 AUR에서 배포중입니다. AUR의 사용법은 ArchWiki의 Arch User Repository 페이지를 참조하세요.

sudo pacman -U <filename>.pkg.tar.zst

그 외

추후에 Appimage로도 번들링하여 distro-agnostic하게 실행 가능하게 할 계획입니다.

직접 빌드 및 실행

git clone https://github.com/northernorca/DmNote.git --depth 1
cd DmNote
npm install
npm run tauri:dev

Nvidia 그래픽 카드를 사용중이라면 마지막 줄을 아래와 같이 바꾸어 explicit sync를 해제해야 합니다.

__NV_DISABLE_EXPLICIT_SYNC=1 npm run tauri:dev

3d08f2b (chore: add linux packaging and versioning) ce9b49e (chore: add linux packaging and versioning)

✨ 주요 기능

⌨️ 키보드 입력 및 매핑

  • 실시간 키보드 입력 감지 및 시각화
  • 커스텀 키 매핑 설정

🎨 키 스타일 커스터마이징

  • 그리드 기반 키 편집
  • 이미지 할당 지원

🌧️ 노트 효과 (Raining Effect) 커스터마이징

  • 노트 효과 스타일 커스터마이징
  • 트랙 속도, 높이 및 리버스 모드 지원

🔢 키 카운터

  • 키별 입력 횟수 표시
  • 카운터 위치, 색상 및 스타일 커스터마이징

📊 입력 통계

  • KPS, AVG, MAX, TOTAL 통계 표시
  • KPS 그래프 시각화
  • 통계 요소 및 그래프 스타일 커스터마이징

🎵 키음 기능

  • 키 입력 시 사운드 효과 재생
  • 사운드 파일 사용자 지정 지원

🖼️ 오버레이 및 창 관리

  • 창 위치 고정 & 항상 위에 표시
  • 리사이즈 기준점 선택

🖥️ OBS 모드

  • OBS 브라우저 소스와 호환되는 모드

🧩 사용자 정의 CSS 및 플러그인 지원

  • 사용자 정의 CSS로 완전히 커스터마이징 가능한 프로그램 인터페이스와 오버레이 스타일
  • 커스텀 플러그인 기능 지원

💾 프리셋 및 설정 관리

  • 사용자 설정 자동 저장
  • 프리셋 저장/불러오기

⚙️ 기타 설정

  • 다국어 인터페이스 지원 (한글, 영어, 중국어 간체/번체, 러시아어)
  • 주요 기능 단축키 설정 지원
  • 설정 초기화 및 자동 업데이트

📝 참고사항

  • 이 프로그램은 스트리밍이나 플레이 영상 제작 등에 자유롭게 사용 가능합니다.
  • macOS 설치 및 권한 설정 가이드
  • 프로그램 기본 설정은 %appdata%/com.dmnote.desktop 폴더에 저장됩니다.
  • 오버레이를 실시간으로 직접 확인할 필요가 없고 스트리밍이나 플레이 영상 제작 등에 사용한다면 기본적으로 OBS 모드 사용을 권장합니다. 이는 일반 오버레이 모드보다 게임 프레임에 대한 악영향을 줄일 수 있습니다.
  • 만약 게임용 컴퓨터와 스트리밍/녹화용 컴퓨터가 분리되어 있는 환경이라면 게임용 컴퓨터에서 DM Note를 실행하고 스트리밍/녹화용 컴퓨터에서 OBS 브라우저 소스로 연결하여 사용하는 것을 추천합니다. 이 경우 키뷰어로 인해 발생하는 게임 프레임 저하 문제를 거의 완전히 해결할 수 있습니다.
  • 항상 위에 표시 기능을 활성화해도 일부 게임의 전체화면에서는 오버레이가 게임에 가려집니다. 이 경우 테두리 없는 창 모드를 사용해주세요.
  • 공식 플러그인과 CSS 예제 파일은 assets.zip 파일에 포함되어 있습니다.
  • 신뢰할 수 없는 플러그인은 절대 불러오지 마세요. 비공식적인 플러그인을 사용할 때는 ChatGPT 등의 도구를 사용하여 해당 플러그인이 안전한지 반드시 확인 후 사용하세요.
  • 클래스명 할당 시 선택자는 제외하고 이름만 입력하세요. (blue ✅, .blue ❌)

🚀 개발

기술 스택

  • 프론트엔드: React 19 + Typescript + Vite 7
  • 백엔드: Tauri
  • 스타일링: Tailwind CSS 3
  • 입력 감지: Raw Input API (Windows), 전역 입력 이벤트 (macOS)
  • 패키지 매니저: npm

기본 설치 및 실행

터미널에서 다음 명령어를 순서대로 입력하세요.

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

Linux의 Nvidia, Wayland 환경에서는 마지막 라인을 다음으로 고쳐서 explicit sync를 비활성화 시켜주세요.

__NV_DISABLE_EXPLICIT_SYNC=1 npm run tauri:dev

Linux 번들링

src-tauri/tauri.linux.conf.json의 버전을 알맞게 수정하고 아래 스크립트를 실행합니다.

./scripts/bundle/bundle.sh

그러면 scripts/bundle/{version}/ 디렉토리 하에 번들링된 패키지가 놓입니다.

🤝 기여하기

여러분의 참여를 환영합니다! 자세한 내용은 기여 가이드를 확인해주세요.

✨ 기여자

이시훈
이시훈

🚧
연우
연우

🎨 🤔
mo_hong
mo_hong

🌍
LSVoiid
LSVoiid

🌍 📖
문주
문주

💻
dustingusius
dustingusius

🌍
Dotoritos
Dotoritos

💻

📄 라이선스

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

❤️ Special Thanks!

About

Unofficial Linux Implementation for DM NOTE: A Fully Customizable Key Viewer Optimized for DJMAX RESPECT V, Ready for Any Game

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • TypeScript 75.0%
  • Rust 19.7%
  • JavaScript 4.2%
  • C# 0.4%
  • CSS 0.4%
  • Swift 0.2%
  • Other 0.1%