Update README.md

This commit is contained in:
peunsu 2024-06-24 23:24:57 +09:00
parent 2ec6eb38f6
commit 4e765da8db

144
README.md
View File

@ -1,4 +1,4 @@
<p align="center"><img src="./app/assets/images/Icon.png" width="150px" height="150px" alt="aventium softworks"></p> <p align="center"><img src="./app/assets/images/Icon.png" width="150px" height="150px" alt="mystic red space"></p>
<h1 align="center">MRS Launcher</h1> <h1 align="center">MRS Launcher</h1>
@ -6,91 +6,94 @@
[<p align="center"><img src="https://img.shields.io/github/actions/workflow/status/peunsu/MRSLauncher/build.yml?branch=master&style=for-the-badge" alt="gh actions">](https://github.com/peunsu/MRSLauncher/actions) [<img src="https://img.shields.io/github/downloads/peunsu/MRSLauncher/total.svg?style=for-the-badge" alt="downloads">](https://github.com/peunsu/MRSLauncher/releases) [<p align="center"><img src="https://img.shields.io/github/actions/workflow/status/peunsu/MRSLauncher/build.yml?branch=master&style=for-the-badge" alt="gh actions">](https://github.com/peunsu/MRSLauncher/actions) [<img src="https://img.shields.io/github/downloads/peunsu/MRSLauncher/total.svg?style=for-the-badge" alt="downloads">](https://github.com/peunsu/MRSLauncher/releases)
[<p align="center"><img src="https://img.shields.io/endpoint?url=https://minecraft-server-status-badge.vercel.app/api/server/mysticred.space?port=25565&logo=curseforge&logoColor=ffffff&label=MRS Server&labelColor=F16436&color=28231d&style=for-the-badge">](https://mysticred.space) [<img src="https://img.shields.io/discord/330997213255827457?style=for-the-badge&logo=discord&logoColor=ffffff&label=Discord&labelColor=6173f4&color=28231d" alt="discord">](https://discord.gg/Z8j6ahF4MJ) [<p align="center"><img src="https://img.shields.io/endpoint?url=https://minecraft-server-status-badge.vercel.app/api/server/mysticred.space?port=25565&logo=curseforge&logoColor=ffffff&label=MRS Server&labelColor=F16436&color=28231d&style=for-the-badge" alt="homepage">](https://mysticred.space) [<img src="https://img.shields.io/discord/330997213255827457?style=for-the-badge&logo=discord&logoColor=ffffff&label=Discord&labelColor=6173f4&color=28231d" alt="discord">](https://discord.gg/Z8j6ahF4MJ)
<p align="center">Join modded servers without worrying about installing Java, Forge, or other mods. We'll handle that for you.</p> <p align="center">Java, Forge, 모드 설치 걱정 없이 서버에 접속하세요. MRS 런처 하나로 준비 끝!</p>
![Screenshot 1](https://i.imgur.com/hL9gCr3.jpg) ![Screenshot 1](https://i.imgur.com/hL9gCr3.jpg)
![Screenshot 2](https://i.imgur.com/m1yHiM6.jpg) ![Screenshot 2](https://i.imgur.com/m1yHiM6.jpg)
## Features ## 기능
* 🔒 Full account management. * 🔒 통합 계정 관리
* Add multiple accounts and easily switch between them. * 여러 계정을 등록하고 쉽게 계정 전환을 할 수 있어요.
* Microsoft (OAuth 2.0) + Mojang (Yggdrasil) authentication fully supported. * Microsoft (OAuth 2.0) + Mojang (Yggdrasil) 인증을 모두 지원해요.
* Credentials are never stored and transmitted directly to Mojang. * 계정 정보는 저장되지 않고 Mojang에 직접 전송돼요.
* 📂 Efficient asset management. * 📂 효율적인 데이터 관리
* Receive client updates as soon as we release them. * 클라이언트 업데이트를 빠르게 받아보세요.
* Files are validated before launch. Corrupt or incorrect files will be redownloaded. * 게임 실행 전에 파일 유효성을 검사하고 문제가 있으면 다시 다운로드해요.
* ☕ **Automatic Java validation.** * ☕ **자동 Java 유효성 검사**
* If you have an incompatible version of Java installed, we'll install the right one *for you*. * 호환되지 않는 Java 버전이 설치되어 있으면 올바른 버전을 **자동으로** 설치해요.
* You do not need to have Java installed to run the launcher. * 런처를 실행하기 위해 Java를 설치할 필요가 없어요.
* 📰 News feed natively built into the launcher. * 📰 런처에 내장된 뉴스 피드
* ⚙️ Intuitive settings management, including a Java control panel. * ⚙️ Java 설정이 가능한 직관적인 설정 화면
* Supports all of our servers. * MRS 서버에 쉽게 접속할 수 있어요.
* Switch between server configurations with ease. * 모드팩이 여러 개 설치되어 있어도 쉽게 전환할 수 있어요.
* View the player count of the selected server. * 서버에 접속한 플레이어 수를 확인할 수 있어요.
* Automatic updates. That's right, the launcher updates itself. * 런처는 자동으로 업데이트돼요.
* View the status of Mojang's services. * Mojang 서비스 상태를 확인할 수 있어요.
This is not an exhaustive list. Download and install the launcher to gauge all it can do! 이 외에도 런처가 할 수 있는 일은 많아요. 지금 다운로드해서 사용해보세요!
#### Need Help? [Check the wiki.][wiki] #### 도움이 필요하신가요? [위키를 확인해보세요.][wiki]
#### Like the project? Leave a ⭐ star on the repository! #### Like the project? Leave a ⭐ star on the repository!
#### 프로젝트가 마음에 드셨나요? [원본 레포지토리](https://github.com/dscalzi/HeliosLauncher)에 ⭐ 스타를 남겨주세요!
## Downloads ## 다운로드
You can download from [GitHub Releases](https://github.com/peunsu/MRSLauncher/releases) [GitHub Releases](https://github.com/peunsu/MRSLauncher/releases)에서 다운로드할 수 있어요.
#### Latest Release #### 최신 릴리즈 버전
[![](https://img.shields.io/github/release/dscalzi/HeliosLauncher.svg?style=flat-square)](https://github.com/peunsu/MRSLauncher/releases/latest) [![](https://img.shields.io/github/release/dscalzi/HeliosLauncher.svg?style=flat-square)](https://github.com/peunsu/MRSLauncher/releases/latest)
#### Latest Pre-Release #### 최신 프리릴리즈 버전
[![](https://img.shields.io/github/release/dscalzi/HeliosLauncher/all.svg?style=flat-square)](https://github.com/peunsu/MRSLauncher/releases) [![](https://img.shields.io/github/release/dscalzi/HeliosLauncher/all.svg?style=flat-square)](https://github.com/peunsu/MRSLauncher/releases)
**Supported Platforms** **지원하는 플랫폼**
If you download from the [Releases](https://github.com/peunsu/MRSLauncher/releases) tab, select the installer for your system. [Releases](https://github.com/peunsu/MRSLauncher/releases) 탭에서 시스템 OS에 맞는 설치 파일을 선택해서 다운로드하세요.
| Platform | File | | 플랫폼 | 파일 |
| -------- | ---- | | -------- | ---- |
| Windows x64 | `MRS-Launcher-setup-VERSION.exe` | | Windows x64 | `MRS-Launcher-setup-VERSION.exe` |
| ~~macOS x64~~ | ~~`MRS-Launcher-setup-VERSION-x64.dmg`~~ | | macOS x64[^1] | `MRS-Launcher-setup-VERSION-x64.dmg` |
| ~~macOS arm64~~ | ~~`MRS-Launcher-setup-VERSION-arm64.dmg`~~ | | macOS arm64[^1] | `MRS-Launcher-setup-VERSION-arm64.dmg` |
| Linux x64 | `MRS-Launcher-setup-VERSION.AppImage` | | Linux x64 | `MRS-Launcher-setup-VERSION.AppImage` |
[^1]: macOS 설치 파일은 서명되지 않아서 보안 경고가 뜰 수 있으며 정상 작동을 보장하지 않아요.
## Console ## 콘솔
To open the console, use the following keybind. 콘솔창을 열려면 아래 단축키를 사용하세요.
```console ```console
ctrl + shift + i ctrl + shift + i
``` ```
Ensure that you have the console tab selected. Do not paste anything into the console unless you are 100% sure of what it will do. Pasting the wrong thing can expose sensitive information. 콘솔창이 열리면 콘솔 탭이 선택되어 있는지 확인하세요. 개발자가 아니라면 콘솔에 아무거나 입력하지 마세요. 인터넷이나 타인이 알려준 코드를 함부로 입력하면 민감한 정보가 노출될 수 있어요.
#### Export Output to a File #### 콘솔 출력을 파일로 내보내기
If you want to export the console output, simply right click anywhere on the console and click **Save as..** 콘솔 출력을 내보내려면 콘솔 어디에서든 마우스 오른쪽 버튼을 클릭하고 **다른 이름으로 저장**을 클릭하세요.
![console example](https://i.imgur.com/T5e73jP.png) ![console example](https://i.imgur.com/T5e73jP.png)
## Development ## 개발
This section details the setup of a basic developmentment environment. 이 섹션에서는 기본 개발 환경 설정 방법을 설명해요.
### Getting Started ### 시작하기
**System Requirements** **시스템 요구사항**
* [Node.js][nodejs] v20 * [Node.js][nodejs] v20
--- ---
**Clone and Install Dependencies** **레포지토리 클론 및 의존 패키지 설치**
```console ```console
> git clone https://github.com/peunsu/MRSLauncher.git > git clone https://github.com/peunsu/MRSLauncher.git
@ -100,7 +103,7 @@ This section details the setup of a basic developmentment environment.
--- ---
**Launch Application** **어플리케이션 실행**
```console ```console
> npm start > npm start
@ -108,31 +111,31 @@ This section details the setup of a basic developmentment environment.
--- ---
**Build Installers** **인스톨러 빌드**
To build for your current platform. 현재 개발하고 있는 플랫폼에 맞는 인스톨러를 빌드하려면 아래 명령어를 사용하세요.
```console ```console
> npm run dist > npm run dist
``` ```
Build for a specific platform. 특정 플랫폼에 맞게 빌드하려면 아래 명령어를 사용하세요.
| Platform | Command | | 플랫폼 | 명령어 |
| ----------- | -------------------- | | ----------- | -------------------- |
| Windows x64 | `npm run dist:win` | | Windows x64 | `npm run dist:win` |
| macOS | `npm run dist:mac` | | macOS | `npm run dist:mac` |
| Linux x64 | `npm run dist:linux` | | Linux x64 | `npm run dist:linux` |
Builds for macOS may not work on Windows/Linux and vice-versa. macOS 빌드는 macOS에서만 가능해요. Windows나 Linux에서 macOS 빌드를 시도하면 제대로 빌드되지 않아요.
--- ---
### Visual Studio Code ### Visual Studio Code
All development of the launcher should be done using [Visual Studio Code][vscode]. 런처 개발은 [Visual Studio Code][vscode]를 사용해서 진행해야 해요.
Paste the following into `.vscode/launch.json` 아래 내용을 `.vscode/launch.json`에 붙여넣기하세요.
```JSON ```JSON
{ {
@ -165,42 +168,53 @@ Paste the following into `.vscode/launch.json`
} }
``` ```
This adds two debug configurations. 이렇게 하면 두 개의 디버그 설정이 추가돼요.
#### Debug Main Process #### 메인 프로세스 디버그
This allows you to debug Electron's [main process][mainprocess]. You can debug scripts in the [renderer process][rendererprocess] by opening the DevTools Window. Electron의 [메인 프로세스][mainprocess]를 디버깅할 수 있어요. [렌더러 프로세스][rendererprocess]의 스크립트를 디버깅하려면 DevTools 창을 열어야 해요.
#### Debug Renderer Process #### Debug Renderer Process
This allows you to debug Electron's [renderer process][rendererprocess]. This requires you to install the [Debugger for Chrome][chromedebugger] extension. Electron의 [렌더러 프로세스][rendererprocess]를 디버깅할 수 있어요. 이 디버그 설정을 사용하려면 [Debugger for Chrome][chromedebugger] 확장을 설치해야 해요.
Note that you **cannot** open the DevTools window while using this debug configuration. Chromium only allows one debugger, opening another will crash the program. 이 디버그 설정을 사용하는 동안에는 DevTools 창을 열 수 없어요. Chromium은 하나의 디버거만 허용하고 두 번째 디버거를 열면 프로그램 충돌이 발생해요.
--- ---
### Note on Third-Party Usage ### 제 3자 사용에 대한 주의사항
Please give credit to the original author and provide a link to the original source. This is free software, please do at least this much. 원작자([dscalzi](https://github.com/dscalzi))와 원본 레포지토리 링크([Helios Launcher](https://github.com/dscalzi/HeliosLauncher))를 표기하여 출처를 명시하면 무료로 사용할 수 있어요.
For instructions on setting up Microsoft Authentication, see https://github.com/dscalzi/HeliosLauncher/blob/master/docs/MicrosoftAuth.md. Microsoft 인증 설정 방법은 [여기](https://github.com/dscalzi/HeliosLauncher/blob/master/docs/MicrosoftAuth.md)를 참고하세요.
--- ---
## Resources ## 리소스
* [Wiki][wiki] * [위키][wiki]
* [Nebula (Create Distribution.json)][nebula] * [Nebula (Distribution.json 생성)][nebula]
* [v2 Rewrite Branch (Inactive)][v2branch] * [v2 Rewrite Branch (비활성화)][v2branch]
The best way to contact the developers is on Discord. 아래 디스코드에서 개발자들과 소통할 수 있어요.
[![discord](https://discordapp.com/api/guilds/211524927831015424/embed.png?style=banner3)][discord] [![discord](https://discordapp.com/api/guilds/211524927831015424/embed.png?style=banner3)][discord]
--- ---
### See you ingame. ## Mystic Red Space
#### 지겨운 플러그인 서버는 이제 그만! 모드팩은 어떠세요?
* 📅 국내 장수 모드팩 서버 & 커뮤니티 (2017년부터 운영, 8년차)
* 🔧 MRS 런처를 이용한 간편한 모드팩 설치와 서버 접속
* 📊 주기적인 유저 제안 및 투표로 모드팩을 선정하여 운영
* 💰 후원금은 모두 서버 호스팅 비용으로 사용되며 후원 내역이 투명하게 공개
* 📰 마인크래프트 모드 관련 뉴스가 실시간으로 업데이트되고, AI 번역 및 알림 설정 기능 제공
아래 디스코드에서 MRS와 함께하세요.
[![discord](https://discordapp.com/api/guilds/330997213255827457/embed.png?style=banner3)][discord]
[nodejs]: https://nodejs.org/en/ 'Node.js' [nodejs]: https://nodejs.org/en/ 'Node.js'
[vscode]: https://code.visualstudio.com/ 'Visual Studio Code' [vscode]: https://code.visualstudio.com/ 'Visual Studio Code'
@ -208,6 +222,6 @@ The best way to contact the developers is on Discord.
[rendererprocess]: https://electronjs.org/docs/tutorial/application-architecture#main-and-renderer-processes 'Renderer Process' [rendererprocess]: https://electronjs.org/docs/tutorial/application-architecture#main-and-renderer-processes 'Renderer Process'
[chromedebugger]: https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome 'Debugger for Chrome' [chromedebugger]: https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome 'Debugger for Chrome'
[discord]: https://discord.gg/zNWUXdt 'Discord' [discord]: https://discord.gg/zNWUXdt 'Discord'
[wiki]: https://github.com/dscalzi/HeliosLauncher/wiki 'wiki' [wiki]: https://github.com/peunsu/MRSLauncher/wiki 'wiki'
[nebula]: https://github.com/dscalzi/Nebula 'dscalzi/Nebula' [nebula]: https://github.com/dscalzi/Nebula 'dscalzi/Nebula'
[v2branch]: https://github.com/dscalzi/HeliosLauncher/tree/ts-refactor 'v2 branch' [v2branch]: https://github.com/dscalzi/HeliosLauncher/tree/ts-refactor 'v2 branch'