Update README.md for clarity (#2543 )

* Update README.md for clarity Readme is now theoretically the ONE THING you send to somebody in need of help. Updated sections for more clarity on support with GC. * Update README.md grammar Co-authored-by: Magix <27646710+KingRainbow44@users.noreply.github.com> --------- Co-authored-by: Magix <27646710+KingRainbow44@users.noreply.github.com>
Updated korean readme to match with latest changes on main english readme. (#2548 )
2025-05-04 19:17:32 +08:00 · 2025-04-26 22:05:59 -04:00 · 2025-04-26 21:49:12 -04:00
2 changed files with 54 additions and 63 deletions
--- a/README.md
+++ b/README.md
@ -18,6 +18,12 @@
 * Spawning monsters via console
 * Inventory features (receiving items/characters, upgrading items/characters, etc)

+## Foreward
+
+### **Grasscutter beyond the latest release will have no handholding in terms of instructions.**
+
+Grasscutter has not been actively maintained and currently (as of January 12th, 2025) only works up to version REL4.0.1 (introduction to Fontaine). If you have a beta version/unofficial version of Grasscutter, this guide should theoretically still work, however, we will not provide official support these versions. You can still try your luck in the Discord if you are stuck, but please don't act entitled.
+
 ## Quick setup guide

 **Note**: For support please join our [Discord](https://discord.gg/T5vZU6UyeG).
@ -29,6 +35,7 @@
 - Get game version REL4.0.x (If you don't have a 4.0.x client, you can find it here and open any of the links to download it):
 [4.0.x Client-github](https://github.com/JRSKelvin/GenshinRepository/blob/main/Version%204.0.0.md)
 [4.0.x Client-cloud drive](https://www.123pan.com/s/HoqUVv-U7SBA.html)
+- ***UPDATE JAN 12, 2025: YOU CANNOT MIX AND MATCH GAME VERSIONS AND SERVER VERSIONS, PLEASE DOWNLOAD THE CORRECT VERSION OF GRASSCUTTER FOR YOUR VERSION OF THE GAME.***

 - Download the [latest Cultivation version](https://github.com/Grasscutters/Cultivation/releases/latest). Use the `.msi` installer.
 - After opening Cultivation (as admin), press the download button in the upper right corner. 
--- a/docs/README_ko-KR.md
+++ b/docs/README_ko-KR.md
@ -22,52 +22,25 @@

 **각주 :** 도움이 필요할 경우 [Discord](https://discord.gg/T5vZU6UyeG)에 가입하세요.

-### 설치에 필요한 것들
+### 빠른 설치 (자동)

-* Java SE - 17 ([링크](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html))
+- [Java 17](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) 설치
+- [MongoDB Community Server](https://www.mongodb.com/try/download/community) 설치
+- 게임 버전 REL4.0.x 다운로드 (만약 4.0.x 클라이언트를 가지고 있지 않다면, 여기서 찾을 수 있습니다.):
+[4.0.x 클라이언트 - GitHub](https://github.com/JRSKelvin/GenshinRepository/blob/main/Version%204.0.0.md)
+[4.0.x 클라이언트 - 구글 드라이브브](https://www.123pan.com/s/HoqUVv-U7SBA.html)

-  **각주 :** **실행**만을 원한다면, **jre**만 있어도 괜찮습니다.
+- [최신 Cultivation](https://github.com/Grasscutters/Cultivation/releases/latest) 다운로드하세요. `.msi` 설치파일을 사용하면 됩니다.
+- (관리자 권한으로) Cultivation을 실행한 후, 우측 상단에 위치한 다운로드 버튼을 클릭하세요.
+- `올인원 다운로드`를 클릭하세요.
+- 우측 상단에 위치한 톱니바퀴 버튼을 누르세요.
+- 게임 설치 경로를 게임이 위치한 경로로 설정하세요.
+- 사용자 지정 Java 경로 설정을 `C:\Program Files\Java\jdk-17\bin\java.exe`로 설정하세요.
+- 다른 모든 설정은 기본값으로 두세요.

-* [MongoDB](https://www.mongodb.com/try/download/community) (4.0 이상의 버전 추천)
-
-* 프록시 데몬 : mitmproxy (mitmdump 추천), Fiddler Classic 등.
-
-### 실행
-
-**각주 :** 구버전에서 업데이트 했을 경우, `config.json` 파일을 재생성하기 위해 파일을 삭제하세요.
-
-1. `grasscutter.jar` 얻기
-   - [Actions](https://github.com/Grasscutters/Grasscutter/suites/6895963598/artifacts/267483297) 탭에서 다운로드
-   - [직접 빌드하기](#빌드하기)
-2. grasscutter.jar 파일이 위치한 폴더에 `resources` 폴더를 생성하고, `BinOutput` 과 `ExcelBinOutput` 폴더를 생성한 폴더 내로 옮기세요. *(이 파일들을 얻는 더 자세한 방법에 대해서는 [위키](https://github.com/Grasscutters/Grasscutter/wiki)를 참조하세요.)*
-3. Grasscutter를 `java -jar grasscutter.jar` 명령어로 실행합니다. **MongoDB 서비스가 정상적으로 실행되고 있는지 확인하세요.**
-
-### 클라이언트와의 연결
-
-½. [서버 콘솔 명령어](https://github.com/Grasscutters/Grasscutter/wiki/Commands#targeting)를 이용해서 계정을 생성합니다.
-
-1. 리다이렉트 트래픽 : (1가지 선택)
-    - mitmdump: `mitmdump -s proxy.py -k`
-
-      신뢰하는 인증 기관 인증서 (CA Cert) :
-
-      	**각주 :** CA 인증서는 보통 `%USERPROFILE%\ .mitmproxy` 경로에 저장되며,  `http://mitm.it`에서 다운로드 받을 수도 있습니다.
-
-      	더블 클릭하여 [설치](https://docs.microsoft.com/en-us/skype-sdk/sdn/articles/installing-the-trusted-root-certificate#installing-a-trusted-root-certificate) 또는 ...
-
-      - 명령어를 통해서
-
-        ```shell
-        certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer
-        ```
-
-    - Fiddler Classic : Fiddler Classic을 실행한 후, Setting에서 `Decrypt https traffic` 옵션을 켜고, Tools -> Options -> Connections에 있는 기본 포트를 `8888`을 제외한 다른 포트로 지정합니다. 그리고 [이 스크립트](https://github.lunatic.moe/fiddlerscript)를 불러옵니다.
-
-    - [호스트 파일](https://github.com/Grasscutters/Grasscutter/wiki/Running#traffic-route-map)
-
-2. 네트워크 프록시를 `127.0.0.1:8080` 로 설정하거나 지정한 프록시 포트로 설정합니다.
-
-**또한 `start.cmd`를 실행함으로써, 서버와 프록시 데몬을 자동으로 실행되게 할 수 있습니다. 이를 이용하기 위해서는 JAVA_HOME 환경 변수를 등록해야 합니다.**
+- 게임 시작 버튼 옆에 위치한 작은 버튼을 누르세요.
+- 게임 시작 버튼을 누르세요.
+- 원하는 사용자 이름으로 로그인하세요. 비밀번호는 무엇이든 가능합니다.

 ### 빌드하기

@ -77,39 +50,50 @@ Grasscutter는 종속성 및 컴파일 처리를 위해 Gradle을 이용합니

 - [Java SE 개발 키트 - 17](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
 - [Git](https://git-scm.com/downloads)
+- [NodeJS](https://nodejs.org/en/download) (선택, 핸드북을 빌드하기 위해 필요함.)

-##### 윈도우 (온라인)
-
+##### 클론
 ```shell
-git clone https://github.com/Grasscutters/Grasscutter.git
+git clone --recurse-submodules https://github.com/Grasscutters/Grasscutter.git
 cd Grasscutter
-.\gradlew.bat # 개발 환경 설정
-.\gradlew jar # 컴파일
 ```

-##### 윈도우 (로컬)
+##### 컴파일
+
+**각주**: 핸드북 생성은 일부 시스템에서 실패할 수도 있습니다. 핸드북 생성을 비활성화하려면, `gradlew jar`명령에 `-PskipHandbook=1`명령줄 스위치를 추가하세요.
+
+
+윈도우:

 ```shell
-cd <로컬 주소>/Grasscutter
-.\gradlew.bat # 개발 환경 설정
-.\gradlew jar # 컴파일
+.\gradlew.bat # 환경 준비
+.\gradlew jar
 ```

-##### 리눅스
+리눅스 (GNU):

 ```bash
-git clone https://github.com/Grasscutters/Grasscutter.git
-cd Grasscutter
 chmod +x gradlew
-./gradlew jar # 컴파일
+./gradlew jar
+```
+
+##### 핸드북 컴파일 (수동동)
+
+Gradle 사용:
+
+```shell
+./gradlew generateHandbook
+```
+
+NPM 사용:
+
+```shell
+cd src/handbook
+npm install
+npm run build
 ```

 프로젝트 폴더의 최상단에서 jar 파일을 찾을 수 있습니다.

-### 명령어들은 [위키](https://github.com/Grasscutters/Grasscutter/wiki/Commands)에서 확인할 수 있습니다.
-
-# 빠른 문제 해결
-
-* 만약 컴파일링이 정상적으로 완료되지 않을 경우, JDK 설치를 확인하세요. (JDK 버전 17 및 JDK의 bin 경로 변수 등록을 확인)
-* 클라이언트가 연결되지 않거나, 로그인이 안 되거나, 4206 오류가 뜨는 등의 경우 - 대부분 프록시 데몬의 설치에 문제가 있을 것입니다. Fiddler를 사용하고 있다면, 8888을 제외한 다른 포트에서 구동되고 있는지 확인하세요.
-* 구동 순서 : MongoDB > Grasscutter > 프록시 데몬 (mitmdump, fiddler 등) > 게임
+### 문제 해결
+흔한 문제들의 해결방법과 도움을 요청하려면, [우리의 디스코드 서버](https://discord.gg/T5vZU6UyeG)에 참가하고 support 채널에 가보세요.