Files
music_quiz/tools/report/build.py

128 lines
11 KiB
Python

"""docs/*.md + 예시 화면 → docs/보고서.pdf
실행: python build.py (markdown 패키지 필요, google-chrome headless 로 PDF 출력)"""
import pathlib, re, subprocess, datetime, markdown
ROOT = pathlib.Path(__file__).resolve().parents[2]
DOCS = ROOT / 'docs'
FONT = 'file:///home/claude/joke-wt/g3-tiles/node_modules/.bun/pretendard@1.3.9/node_modules/pretendard/dist/public/variable/PretendardVariable.ttf'
md = lambda t: markdown.markdown(t, extensions=['tables', 'fenced_code', 'sane_lists'])
def doc(name):
t = (DOCS / name).read_text()
t = re.sub(r'^# (\d+)\. ', r'# \1. ', t, flags=re.M)
return md(t)
shots = [
('home.png', '첫 화면', '디스코드 로그인/게스트 시작, 열린 방 목록(대기·진행 중, 중간 참여).'),
('room.png', '대기실 + 방 설정', '인원 제한 없음. 모드·세부모드·장르·연도 슬라이더·난이도 별 10개·정답방식·정답인식 토글·힌트·스킵인원(느낌표 말풍선)·문제 수.'),
('modes.png', '모드별 세부 설정', '듣고맞추기(듣는 시간·재생위치) / 가수노래 맞추기(검색해서 추가, 누르면 빠짐) / 가사보고 맞추기(보는 시간).'),
('game.png', '게임 화면 — 듣고맞추기', '채팅을 가운데 아래에 가장 크게. 정답 줄 아래 공백 5줄 가운데에 "노래제목 - 가수". 입력 중 표시, 힌트(Ctrl+I)·스킵(Ctrl+K) 버튼과 투표 수.'),
('lyrics.png', '가사보고 맞추기 무대', '가사 4줄 → 시간이 지나면 2줄씩 추가, 제목 단어는 가림. (가사는 예시로 지어낸 문장)'),
('admin.png', '관리자 — 노래 관리', '검색(초성 포함)·필터·정렬 표 + 오른쪽 편집 패널: 정답 별칭, 난이도 자동/수동, 유튜브 Topic 후보와 점수, 미리듣기에서 하이라이트 지정.'),
]
css = f"""
@font-face{{font-family:'Pretendard';font-weight:100 900;src:url('{FONT}')}}
@page{{size:A4;margin:16mm 15mm 16mm 15mm}}
*{{box-sizing:border-box}}
body{{font-family:'Pretendard',sans-serif;color:#1E1B18;font-size:10.4pt;line-height:1.62;word-break:keep-all;margin:0}}
h1{{font-size:20pt;font-weight:850;letter-spacing:-.03em;margin:0 0 10pt;padding-bottom:6pt;border-bottom:2.5pt solid #1E1B18;break-before:page}}
h1.first{{break-before:auto}}
h2{{font-size:13.5pt;font-weight:800;margin:16pt 0 6pt;color:#1F6F78}}
h3{{font-size:11.5pt;font-weight:800;margin:12pt 0 4pt}}
p{{margin:4pt 0}}
ul,ol{{margin:4pt 0;padding-left:16pt}} li{{margin:1.5pt 0}}
table{{border-collapse:collapse;width:100%;margin:6pt 0 8pt;font-size:9.2pt;break-inside:auto}}
th{{background:#EFE6D3;text-align:left;font-weight:800;border:1px solid #CFC3AC;padding:4pt 6pt}}
td{{border:1px solid #DDD2BE;padding:3.5pt 6pt;vertical-align:top}}
tr{{break-inside:avoid}}
code{{font-family:'D2Coding','DejaVu Sans Mono',monospace;font-size:8.8pt;background:#F3ECDD;padding:0 3pt;border-radius:3pt}}
pre{{background:#F7F2E7;border:1px solid #DDD2BE;border-radius:6pt;padding:7pt 9pt;font-size:8.6pt;line-height:1.45;white-space:pre-wrap;break-inside:avoid}}
pre code{{background:none;padding:0}}
strong{{font-weight:800}}
.cover{{height:255mm;display:flex;flex-direction:column;justify-content:center;align-items:flex-start;padding:0 8mm;background:#F5EFE3;border:2.5pt solid #1E1B18;border-radius:14pt}}
.cover img{{width:46mm;height:46mm}}
.cover .t{{font-size:34pt;font-weight:900;letter-spacing:-.04em;margin-top:10mm;line-height:1.15}}
.cover .s{{font-size:13pt;color:#6B6157;font-weight:650;margin-top:4mm}}
.cover .meta{{margin-top:18mm;font-size:10.5pt;line-height:1.9}}
.cover .meta b{{display:inline-block;width:28mm;color:#6B6157}}
.shot{{break-inside:avoid;margin:0 0 9pt}}
.shot img{{width:100%;border:1.5pt solid #1E1B18;border-radius:6pt;display:block}}
.shot .cap{{font-size:9.3pt;color:#4a443d;margin-top:3pt}}
.shot .cap b{{color:#1E1B18;font-size:10pt;margin-right:5pt}}
.pair{{display:flex;gap:10pt;align-items:flex-start}}
.pair .shot{{flex:1}}
.box{{background:#F7F2E7;border:1.5pt solid #1E1B18;border-radius:8pt;padding:8pt 11pt;margin:6pt 0;break-inside:avoid}}
.box.teal{{background:#E3F0EF}}
.toc li{{margin:2pt 0}}
.part{{font-size:9pt;font-weight:800;color:#1F6F78;letter-spacing:.08em}}
"""
def shot(f, title, cap, w=None):
return f'<div class="shot"><img src="{(DOCS/'mockups'/'out'/f).resolve().as_uri()}"><div class="cap"><b>{title}</b>{cap}</div></div>'
today = datetime.date.today().isoformat()
html = [f'<!doctype html><html lang="ko"><head><meta charset="utf-8"><style>{css}</style></head><body>']
html.append(f'''<div class="cover"><img src="{(ROOT/'assets/brand/icon.svg').as_uri()}"><div class="t">음악퀴즈<br>설계 보고서</div>
<div class="s">같이 듣고, 채팅으로 먼저 맞히는 실시간 노래 맞추기</div>
<div class="meta"><b>단계</b>0단계 · 설계 (개발 시작 전)<br><b>작성일</b>{today}<br><b>주소</b>https://mquiz.tkrmagid.kr (포트 2974)<br><b>리포</b>git.tkrmagid.kr/tkrmagid/music_quiz<br><b>마지막 장</b>질문 · 요청사항 — 답변 부탁드립니다</div></div>''')
html.append('<h1>1. 한눈에 보기</h1>')
html.append(md('''
- **무엇**: 친구들이 방에 모여 노래를 듣고(또는 가사를 보고) 채팅으로 제목·가수를 먼저 맞히는 사이트. 스타크래프트 노래 맞추기 맵 감성 그대로
- **어떻게**: joke-app(같이 놀자 보드게임)의 로그인·관리자·채팅·실시간 방 구조를 가져오고, 컴퓨터 대결은 빼고, 인원 제한을 없앰
- **모드 3가지**: 듣고맞추기(1초~끝까지, 처음/하이라이트) · 가수노래 맞추기(가수 여러 명 선택) · 가사보고 맞추기(30초~무제한)
- **방 설정**: 장르(복수), 연도 슬라이더, 난이도 별 10개(색 4단계), 정답방식(제목/가수/제목+가수 순서무관), 정답인식 토글, 힌트, 스킵인원
- **채팅**: 화면 가운데 아래 가장 크게, 입력 중 표시, 지연 없음, 정답 아래 5줄 공백 사이에 "노래제목 - 가수", Ctrl+I 힌트 · Ctrl+K 스킵
- **노래 DB**: 스타맵 803곡 + 노라보세 8,572곡 + 멜론·지니·벅스 연도별/실시간 + 유튜브·스포티파이 플레이리스트 → 멜론 정보로 연도·장르, 여러 지표로 난이도 10단계, 유튜브 Topic 주소(`https://youtu.be/ID`)
- **관리자**: joke-app과 같은 관리자 화면 + 노래 관리(검색·필터·추가·삭제·수정), 슈퍼어드민 2명 동일
'''))
html.append('<h2>미리 확인한 것</h2>')
html.append(md('''
| 확인 | 결과 |
|---|---|
| 디스코드 앱(1561284577564037140) | 클라이언트 ID·시크릿 정상(토큰 발급 성공), 앱 이름 "음악퀴즈", **아이콘 비어 있음 → 업로드 필요** |
| 도메인 mquiz.tkrmagid.kr | DNS 등록됨(CNAME → tkrmagid.kr). 프록시·인증서는 1~2단계에서 설정 |
| 유튜브 Topic 찾기 | 일반 유튜브 검색 + "- Topic" 필터로 공식 음원 확인(예: 광(狂) → SG Wannabe - Topic). 유튜브 뮤직 "노래" 검색은 로그인 쿠키 필요, Lavalink `ytmsearch:`는 현재 빈 결과 |
| 하이라이트 | 유튜브 "가장 많이 다시 본 구간" 데이터를 받을 수 있음(광(狂) → 75.8초 = 후렴) |
| 노라보세 데이터 | 8,572곡(1984~2026 주간 TOP50), 멜론 곡 ID 기준, 곡별 유튜브 ID·가사 포함 |
| 멜론·지니·벅스 | 연도별·실시간 차트 대부분 그대로 받아짐(벅스 연도별만 별도 처리) |
| sta_songs.json | 803곡, 연도는 275곡만 있음 → 멜론 발매일로 다시 맞춤 |
'''))
html.append('<h2>진행 순서</h2>')
html.append(md('''
1. **설계(지금)** → 답변 받으면
2. 뼈대 + **배포 먼저**: 실제 주소에서 디스코드 로그인(아이콘 보이는 동의 화면) 확인
3. 노래 DB 1차(약 9천 곡) · 방/로비 · 게임 핵심 · 채팅을 차례로, 단계마다 gitea에 커밋
4. 힌트·스킵·모드 3종 → 관리자 완성 → 수집 확장(1만 곡+) → 휴대폰·다크 테마·부하 테스트
'''))
html.append('<h1>2. 화면 예시</h1><p>실제 앱이 아닌 디자인 확인용 예시입니다. 곡·점수·통계 숫자는 모두 예시 데이터입니다.</p>')
for f, t, c in shots[:3]:
html.append(shot(f, t, c))
html.append(shot(*shots[3]))
html.append(f'<div class="pair"><div class="shot" style="flex:2.2"><img src="{(DOCS/'mockups/out/lyrics.png').as_uri()}"><div class="cap"><b>{shots[4][1]}</b>{shots[4][2]}</div></div><div class="shot" style="flex:1"><img src="{(DOCS/'mockups/out/mobile.png').as_uri()}"><div class="cap"><b>휴대폰</b>무대는 위 띠, 점수는 가로 칩, 채팅이 화면 대부분, 💡⏭ 버튼.</div></div></div>')
html.append(shot(*shots[5]))
html.append('<h2>아이콘</h2>')
html.append(shot('../../../assets/brand/icon-preview.png', '사이트·디스코드·파비콘', 'LP 판 + 물음표 레이블 + 톤암. 청록 바탕·겨자 레이블. 디스코드용은 원형으로 잘려도 보이게 여백을 둠. 16px 파비콘은 단순화 버전.'))
html.append('<h1>3. 상세 설계</h1><div class="part">이하 각 문서는 리포 docs/ 폴더의 md 파일과 같은 내용입니다</div>')
html.append('<ul class="toc">' + ''.join(f'<li>{n}</li>' for n in ['01 구조와 기술 스택','02 로그인 · 권한 · 관리자 페이지','03 UI · 디자인','04 방 설정','05 게임 진행','06 채팅','07 노래 DB','08 유튜브 Topic · 재생 · 하이라이트','09 배포 · 운영','10 작업 순서']) + '</ul>')
for i, name in enumerate(['01-architecture.md','02-auth-admin.md','03-ui-design.md','04-room-settings.md','05-game-flow.md','06-chat.md','07-song-database.md','08-youtube-playback.md','09-deploy-ops.md','10-roadmap.md']):
h = doc(name)
if i == 0:
h = h.replace('<h1>', '<h1 style="break-before:avoid;margin-top:16pt">', 1)
html.append(h)
html.append('<h1>4. 질문 · 요청사항</h1>')
q = (DOCS / '11-questions.md').read_text().split('\n', 1)[1]
html.append('<div class="box teal">' + md('답을 주시지 않은 항목은 **추천안(★)** 으로 진행합니다. 번호만 골라 답해 주셔도 됩니다.<br>예) "Q1 A, Q7 2번, 나머지 추천대로"') + '</div>')
html.append(md(q.replace('답을 주시지 않은 항목은 **추천안(★)** 으로 진행합니다. 번호만 골라서 답해 주셔도 됩니다. (예: "Q1 A, Q7 2번, 나머지 추천대로")', '')))
html.append('</body></html>')
out_html = ROOT / 'tools' / 'report' / 'report.html'
out_html.write_text('\n'.join(html))
pdf = DOCS / '보고서.pdf'
subprocess.run(['google-chrome', '--headless=new', '--disable-gpu', '--allow-file-access-from-files', '--no-pdf-header-footer',
'--virtual-time-budget=4000', f'--print-to-pdf={pdf}', out_html.as_uri()], check=True, capture_output=True)
print(pdf, pdf.stat().st_size)