콘텐츠로 이동

편집 가이드

이 위키는 마크다운 파일 모음입니다. docs/ 아래 .md 파일을 고치고 main 브랜치에 푸시하면 자동으로 배포됩니다.

용어 규칙 (가장 중요)

번역기를 돌린 문구는 인게임 표기와 달라서 읽는 사람이 알아보기 어렵습니다. 그래서 이 위키는 인게임 한글 표기를 그대로 씁니다.

  1. 용어는 data/glossary.yml 에 등록된 한글 표기만 사용합니다.
  2. 처음 등장하는 용어 뒤에는 영문을 작게 붙입니다: 필터<span class="en">Filter</span> → 필터Filter
  3. 인게임에서 확인하지 못한 임시 번역은 status: unverified 로 두고, 문서에서는 <span class="tbd">임시 번역</span> 로 표시합니다.
  4. 영문 위키 문장을 그대로 번역해 옮기지 않습니다. 사실(수치·레시피·조건)만 가져와 우리말로 새로 씁니다. 출처는 출처·저작권 참고.

인게임 용어 추출 방법

게임은 Electron 앱이고 모든 텍스트가 resources/app.asar 안에 있습니다. 게임이 설치된 PC에서 한 번만 실행하면 됩니다.

# Python 3.8 이상 필요 (윈도우: Microsoft Store 에서 Python 설치)
python tools/extract_locale.py
# 자동 탐색이 실패하면 설치 폴더 지정 (Steam → Sandustry 우클릭 → 관리 → 로컬 파일 보기)
python tools/extract_locale.py --game "D:\SteamLibrary\steamapps\common\Sandustry"

결과물 data/locale/report.md 를 열어 한글이 들어간 파일을 확인하고, 로케일 JSON(en/ko 짝)이 나왔으면 다음을 실행합니다.

pip install pyyaml
python tools/build_glossary.py     # glossary.yml 의 인게임 항목 자동 채움
python tools/render_glossary.py    # docs/meta/glossary.md 표 재생성
python tools/check_terms.py        # 문서 안 표기 불일치 검사

로케일 JSON 이 따로 없고 번들 JS 안에 문자열이 박혀 있는 경우에도 data/locale/ko_strings.txt 가 만들어지며, build_glossary.py 가 그 목록으로 기존 항목을 대조해 ingame 으로 승격합니다.

로컬 미리보기

python -m venv .venv && . .venv/bin/activate     # 윈도우: .venv\Scripts\activate
pip install -r requirements.txt
mkdocs serve        # http://127.0.0.1:8000

문서 작성 팁

  • 페이지 맨 위 # 제목 은 한글 용어, 바로 아래 한 줄에 영문 원어와 한 줄 요약.
  • 수치는 표로. 출처가 갈리는 수치는 !!! warning "출처 불일치" 블록으로 표시.
  • 게임 버전이 중요한 정보에는 (v0.5.x 기준) 처럼 버전을 적습니다.
  • 새 페이지를 만들면 mkdocs.yml 의 nav 에도 추가합니다. mkdocs build --strict 가 깨진 링크를 잡아 줍니다.