From a10ca672105ca0fe419702586197f87355510e4e Mon Sep 17 00:00:00 2001 From: claude-bot Date: Thu, 7 May 2026 23:44:03 +0900 Subject: [PATCH] Clean project docs and sample pack --- README.md | 109 +++++++++++++------------------------- manifest/sample-pack.json | 2 +- 2 files changed, 37 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index 08fe73d..6b53fea 100644 --- a/README.md +++ b/README.md @@ -1,103 +1,66 @@ # Minecraft Server Pack Easy Installer -Node.js + TypeScript + Express + EJS 기반 관리 사이트와 Electron 기반 Windows 설치기 프로젝트입니다. +마인크래프트 서버팩 관리 사이트와 Windows 설치기 프로젝트입니다. -## 실행 +- 관리 사이트: `Node.js + TypeScript + Express + EJS` +- 설치기: `Electron` + +## 요구사항 + +- Node.js 22 + +## 설치 ```bash npm install -npm run build +``` + +## 관리 사이트 실행 + +```bash npm start ``` -관리 사이트 기본 주소: +- 주소: `http://127.0.0.1:3000` +- 관리자 로그인: + - `id: admin` + - `password: change-me` -```text -http://127.0.0.1:3000 -``` - -설치기 개발 실행: +## 설치기 실행 ```bash npm run installer ``` -Windows 설치 파일 빌드: +- 기본 `manifest.json` 주소: `http://127.0.0.1:3000/manifest.json` +- 설치기는 서버팩 목록 조회, 경로 검사, JDK 탐색, 다운로드/압축 해제, EULA 동의, 설정 편집기, 포트 개방 시도, 완료 단계를 제공합니다. + +## Windows `.exe` 빌드 ```bash npm run dist:win ``` -기본 관리자 계정: +- 결과물은 `release/` 아래에 생성됩니다. -```text -id: admin -password: change-me -``` -- 실패하면 `직접 포트포워딩 해주세요` 안내를 표시합니다. -- 접속 주소를 직접 입력한 경우에는 자동 포트 개방을 건너뜁니다. +## 빠른 테스트 순서 -## 관리자 사이트 +1. `npm install` +2. `npm start` +3. 브라우저에서 `http://127.0.0.1:3000` 확인 +4. 새 터미널에서 `npm run installer` -```bash -npm run admin -``` +## 기본 데이터 -- 기본 주소: `http://127.0.0.1:8787` -- `distribution.json` 업로드 / 새로 만들기 / 입력 폼 편집 가능 -- 월드 ZIP 업로드 가능 -- 서버용 버킷 JAR 업로드 가능 -- 서버 메모리, 최대 인원수, 화이트리스트, 포트 설정 가능 -- 상단의 `앱 연결용 catalog URL`을 런처 설정의 `카탈로그 주소`에 넣으면 앱이 원격 catalog를 읽습니다. +- 서버팩 목록: [manifest.json](manifest.json) +- 샘플 서버팩: [manifest/sample-pack.json](manifest/sample-pack.json) +- 샘플 ZIP: [file/sample-pack.zip](file/sample-pack.zip) -공개 주소로 관리자 사이트를 띄울 때: +샘플 ZIP은 흐름 확인용입니다. 실제 서버 실행까지 테스트하려면 `file/` 아래에 실제 서버팩 ZIP을 넣고 `manifest/*.json`의 `packPath`를 그 파일명으로 바꾸면 됩니다. -```bash -LAUNCHER_PUBLIC_BASE_URL=https://your-domain.example npm run admin -``` - -문서: - -- [docs/admin-site.md](docs/admin-site.md) -- [docs/launcher-catalog.md](docs/launcher-catalog.md) - -## 개발 - -요구사항: - -- Node.js 22 - -설치: - -```bash -npm install -``` - -개발 실행: - -```bash -npm start -``` - -윈도우 smoke 테스트: - -```bash -npm run smoke:win -``` - -TypeScript 메인 프로세스만 빌드: +## 검증 ```bash npm run build +npm run smoke ``` - -배포 빌드: - -```bash -npm run dist:win -``` - -## 참고 - -- Upstream: `https://github.com/peunsu/MRSLauncher` -- Original base: `https://github.com/dscalzi/HeliosLauncher` diff --git a/manifest/sample-pack.json b/manifest/sample-pack.json index 12efcb9..83f9431 100644 --- a/manifest/sample-pack.json +++ b/manifest/sample-pack.json @@ -5,7 +5,7 @@ "clientMinRam": 4096, "clientRecommendedRam": 8192, "packPath": "sample-pack.zip", - "description": "기본 샘플 서버팩", + "description": "새 서버팩", "configEditableFiles": [ "server.properties", "bukkit.yml"