Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/planetarium/9c-launcher
Nine Chronicles Launcher
https://github.com/planetarium/9c-launcher
electron hacktoberfest hacktoberfest2024
Last synced: about 16 hours ago
JSON representation
Nine Chronicles Launcher
- Host: GitHub
- URL: https://github.com/planetarium/9c-launcher
- Owner: planetarium
- License: gpl-3.0
- Created: 2020-05-27T06:35:35.000Z (over 4 years ago)
- Default Branch: development
- Last Pushed: 2024-09-13T08:09:56.000Z (5 months ago)
- Last Synced: 2024-09-14T17:01:21.391Z (5 months ago)
- Topics: electron, hacktoberfest, hacktoberfest2024
- Language: TypeScript
- Homepage:
- Size: 102 MB
- Stars: 44
- Watchers: 12
- Forks: 34
- Open Issues: 40
-
Metadata Files:
- Readme: README.ko.md
- Contributing: CONTRIBUTING.ko.md
- License: LICENSE
Awesome Lists containing this project
README
# Nine Chronicles Launcher
## 개요
### 이 리드미는 굉장히 오래전 내용이며 수정되지 않아 현재 상황을 반영하지 못합니다!
[대신 위키를 읽어주세요!](https://github.com/planetarium/9c-launcher/wiki)
Nine Chronicles를 구동하기 위한 일렉트론 기반의 멀티플랫폼 런처입니다.
기본적인 골격은 다음과 같습니다:
```
./src
| +-- resources
| +-- styles
| +-- views
| | +-- MainView.tsx
| | +-- LoginView.tsx
| | +-- LobbyView.tsx
| +-- main-process.ts
| +-- App.tsx
```
## 실행 방법
먼저, 개발에 필요한 의존성부터 모두 설치합니다.
```bash
yarn
```
추가로, 한 개의 별도 바이너리가 필요합니다.
- 9C Headless (Standalone): `yarn build-headless`로 빌드 가능
(.NET Core SDK 필요)
9C Headless바이너리를 빌드하기 전에 git submodule 로 해당 바이너리의 소스를 받으셔야 합니다: `git submodule update --recursive`
바이너리를 해당 디렉터리와 같게 배치해 주십시오.
```
./src
./build
| +-- 9c.(exe|app) // 9C Unity Player
| +-- publish // 9C Headless (Standalone)
| | +-- Libplanet.dll
| | +-- Grpc.Core.dll
| | +-- ...
| | +-- NineChronicles.Standalone.Executable(.exe)
```
그 뒤 하기의 명령어를 입력합니다.
```javascript
yarn dev
```
## 개발 방법
기본적으로 프론트엔드는 `webpack-hot-reload` 가 있어, 변경하는 즉시 반영됩니다.
렌더러 프로세스에서 작업할 때는 일렉트론 재시작이 필요가 없으며, 메인 프로세스에 변경점이 생기면 그때 일렉트론 종료 후 재실행 해 주십시오.
### mobx-devtools
mobx-devtools를 사용할 수 있습니다. 먼저, 스탠드얼론 mobx-devtools를 설치해 주십시오
```sh
yarn global add mobx-devtools
```
그 다음, mobx-devtools를 실행해 주십시오
```sh
mobx-devtools
```
이제 `yarn server` 와 `yarn start`를 하시면 mobx-devtools에 전역 상태가 나타나는 것을 볼 수 있습니다.
## 빌드 방법
```bash
git submodule update --recursive # 9C Headless 와 Unity Player 빌드 소스 다운로드하기
yarn
yarn build # 개발 빌드
yarn build-headless # 9C Headless (Standalone) 빌드 (.NET Core SDK 필요)
APV_SIGN_KEY=... APV_NO=... yarn sign-apv # APV 서명 (planet 명령 필요)
yarn build-prod # 프로덕션 빌드
```
## 패키징 방법
```bash
# 주어진 비밀키로 새 버전 APV를 생성/서명 후 적용
APV_SIGN_KEY=... yarn pack-all
# 주어진 비밀키로 지정된 버전의 APV를 생성/서명 후 적용
APV_SIGN_KEY=... APV_NO=1234 yarn pack-all
# 주어진 APV를 그대로 적용
APV=... yarn pack-all
# APV 미적용 (가장 마지막에 릴리스된 패키지에 적용된 APV 재사용)
yarn pack-all
```
다음 환경 변수를 요구합니다. `APV`와 `APV_SIGN_KEY` 양 쪽 모두 누락됐을 경우
APV(앱 프로토콜 버전) 서명을 안 합니다.
- `APV`: APV 토큰
([`Libplanet.Net.AppProtocolVersion.Token`][appprotocolversion.token]).
이게 주어지면 아래 세 환경 변수는 무시되고, 이 빌드 및 패키징된 앱은 이 `APV`를
쓰도록 설정됩니다.
- `APV_SIGN_KEY`: APV 서명에 쓸 비밀키의 16진수 문자열.
- `APV_NO`: APV 숫자
([`Libplanet.Net.AppProtocolVersion.Version`][appprotocolversion.version]).
생략시 [download.nine-chronicles.com](https://download.nine-chronicles.com/)의
최신 버전에 1을 더한 값을 자동으로 사용합니다.
[appprotocolversion.token]: https://docs.libplanet.io/master/api/Libplanet.Net.AppProtocolVersion.html#Libplanet_Net_AppProtocolVersion_Token
[appprotocolversion.version]: https://docs.libplanet.io/master/api/Libplanet.Net.AppProtocolVersion.html#Libplanet_Net_AppProtocolVersion_Version
### 패키지에서 config.json 내용만 갈아끼우기
패키징된 _Windows.zip_ 또는 _macOS.tar.gz_ 파일에서 _config.json_ 설정 내용만 갈아끼울 때
_scripts/extract-config.sh_ 및 _scripts/replace-config.sh_ 스크립트를 활용하면 편합니다.
```bash
# 패키지에서 config.json 내용만 추출 (Windows.zip 대신 macOS.tar.gz도 가능)
scripts/extract-config.sh path/Windows.zip > config.json
# 패키지 내 config.json 내용을 교체 (Windows.zip 대신 macOS.tar.gz도 가능)
scripts/replace-config.sh path/Windows.zip < config.json
```
### electron-builder로 패키징하기
```bash
# Windows (nsis)
# macOS (dmg, zip)
yarn pack-all:electron-builder
```
## 로깅 위치
로그는 다음 위치에 쌓입니다.
```
- on macOS: ~/Library/Logs/{app name}/{process type}.log
- on Windows: %USERPROFILE%\AppData\Roaming\{app name}\logs{process type}.log
```
## 코드 스타일 맞추기
```bash
npx pretty-quick --staged
```
### Visual Studio Code 확장
확장 화면(Windows: ⇧⌃X, macOS: ⇧⌘X)에서 다음 확장들을 설치합니다.
- [EditorConfig]
- [ESlint]
- [Prettier]
[editorconfig]: https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig
[eslint]: https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
[prettier]: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode