Files
music_quiz/docs/00-overview.md

3.5 KiB

00. 개요

한 줄 요약

친구들끼리 방을 만들어 노래를 듣고(또는 가사를 보고) 채팅으로 제목·가수를 맞히는 실시간 음악퀴즈 사이트. 스타크래프트 "노래 맞추기" 유즈맵의 손맛(채팅으로 바로 정답, 초성 힌트, 스킵 투표)을 웹으로 옮긴다.

기본 정보

항목 값
리포 https://git.tkrmagid.kr/tkrmagid/music_quiz (main)
도메인 https://mquiz.tkrmagid.kr (DNS CNAME → tkrmagid.kr 이미 등록됨)
포트 호스트 2974 → 컨테이너 3000
서버 위치 .9 (joke-app과 같은 호스트), 앞단 NPMplus(192.168.10.3)에서 HTTPS 종료
로그인 디스코드 OAuth2 (앱 ID 1561284577564037140, 앱 이름 "음악퀴즈") + 게스트
기반 joke-app(같이 놀자 보드게임)의 구조·로그인·관리자·UI 컴포넌트를 가져와 음악퀴즈 전용으로 변형

범위 (이번 버전)

  • 로비: 방 목록, 방 만들기, 코드로 참여
  • 방: 인원 무제한, 방장 설정(모드·장르·연도·난이도·정답방식 등), 준비/시작/강퇴/방장 넘기기
  • 게임: 듣고맞추기 / 가수노래 맞추기 / 가사보고 맞추기, 채팅 정답, 힌트(Ctrl+I), 스킵(Ctrl+K), 점수판
  • 채팅: 화면 가운데 아래 크게, "입력 중" 표시, 지연 없는 전송, 정답 시 5줄 공백 사이 "노래제목 - 가수" 표시
  • 노래 DB: 여러 차트/플레이리스트/다른 퀴즈 사이트에서 수집 → 연도·장르·난이도 자동 분류 → 유튜브 Topic 음원 주소 등록
  • 관리자: 노래 관리(검색·필터·추가·수정·삭제), 수집 작업, 방/사이트/사용자/관리자 설정, 감사 기록
  • 슈퍼어드민: joke-app과 같은 디스코드 ID 2명

제외

  • 컴퓨터(봇)와 대결 — joke-app의 봇 관련 코드는 가져오지 않는다
  • 유료 결제, 랭킹 시즌 같은 부가 기능 (추후 검토)

문서 목록

파일 내용
01-architecture.md 기술 스택, 폴더 구조, joke-app에서 가져올 것/뺄 것
02-auth-admin.md 디스코드 로그인, 게스트, 권한(슈퍼어드민/관리자), 관리자 페이지
03-ui-design.md 디자인 방향, 색, 글꼴, 화면별 구성, 아이콘
04-room-settings.md 방 설정 항목 전체 (모드·세부모드·장르·연도·난이도·정답·힌트·스킵)
05-game-flow.md 라운드 진행, 정답 판정, 힌트, 스킵, 점수, 단축키
06-chat.md 채팅 배치, 입력 중 표시, 지연 없는 전송, 정답 표시 방식
07-song-database.md 노래 수집 출처, DB 구조, 난이도·연도·장르 분류
08-youtube-playback.md 유튜브 Topic 주소 찾기(music_bot_v2·Lavalink), 재생 방식, 하이라이트
09-deploy-ops.md 배포, 프록시, 인증서, 백업, 모니터링
10-roadmap.md 작업 순서와 마일스톤
11-questions.md 사용자에게 확인할 질문·요청사항
12-decisions.md 사용자 답변으로 확정된 사항(다른 문서보다 우선)

그 밖의 자료

위치 내용
docs/보고서.pdf 이 문서들을 묶은 보고서(화면 예시·질문 포함). 다시 만들기: python tools/report/build.py
docs/mockups/ 예시 화면 HTML과 이미지(out/*.png)
assets/brand/ 아이콘(사이트·디스코드·파비콘)
docs/research/ 참고 사이트 조사 자료(노라보세 JSON, 마추기 화면)
data/seed/sta_songs.json 스타크래프트 노래맞추기 맵 803곡