From 877f747d014bf0a10018b1063ff19cbd3c4012ab Mon Sep 17 00:00:00 2001 From: AwayJob <66241829+AwayJob@users.noreply.github.com> Date: Wed, 26 Oct 2022 09:45:08 +0800 Subject: [PATCH] Update README and fil-PH (#1901) * made it more c l e a r e r * add . * Update README.md * Capitalised HTTPS * update actions to build * fixed typo Fixed the bullet point spacing, removed http://mitm.it as the download page don't exist anymore, added `mitmproxy-ca-cert.cer` and save script into the instruction. * added additional info about mitmproxy * minor fixes * Update README_fil-PH Synced with the README Removed bad words, insults like saying the user has skill issues Added some professionally * grammar fix --- README.md | 12 ++++----- README_fil-PH.md | 68 +++++++++++++++++++++--------------------------- 2 files changed, 35 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 9ebefb347..5acbf2243 100644 --- a/README.md +++ b/README.md @@ -37,13 +37,13 @@ **Note:** If you updated from an older version, delete `config.json` to regenerate it. 1. Get `grasscutter.jar` - - Download from [actions](https://github.com/Grasscutters/Grasscutter/actions/workflows/build.yml) or [build the server by yourself](#building). + - Download from [releases](https://github.com/Grasscutters/Grasscutter/releases/latest) or [actions](https://github.com/Grasscutters/Grasscutter/actions/workflows/build.yml) or [build the server by yourself](#building). 2. Create a `resources` folder in the directory where grasscutter.jar is located and move your `BinOutput, ExcelBinOutput, Readables, Scripts, Subtitle, TextMap` folders there *(Check the [wiki](https://github.com/Grasscutters/Grasscutter/wiki) for more details how to get those.)* 3. Run Grasscutter with `java -jar grasscutter.jar`. **Make sure mongodb service is running as well.** ### Connecting with the client -½. Create an account using [server console command](https://github.com/Grasscutters/Grasscutter/wiki/Commands#targeting). +½. Create an account in the server console using this [command](https://github.com/Grasscutters/Grasscutter/wiki/Commands#:~:text=account%20%3Ccreate|delete%3E%20%3Cusername%3E%20[UID]). 1. Redirect traffic: (choose one only) - mitmdump: `mitmdump -s proxy.py -k` @@ -58,7 +58,6 @@ certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer ``` - - Fiddler Classic: Run Fiddler Classic, turn on `Decrypt HTTPS traffic` in (Tools -> Options -> HTTPS) and change the default port in (Tools -> Options -> Connections) to anything other than `8888`, load [this script](https://github.com/Grasscutters/Grasscutter/wiki/Resources#fiddler-classic-jscript) (copy and paste the script in the `FiddlerScript` tab) and click the `Save Script` button. - [Hosts file](https://github.com/Grasscutters/Grasscutter/wiki/Resources#hosts-file) @@ -67,7 +66,7 @@ - For mitmproxy: After setting up the network proxy and installing the certificate, check http://mitm.it/ if traffic is passing through mitmproxy. -**You can also use `start.cmd` to start servers and proxy daemons automatically, but you have to set up `JAVA_HOME` enviroment and configure the `start_config.cmd` file.** +**You can also use `start.cmd` to start servers and proxy daemons automatically, but you have to set up `JAVA_HOME` environment and configure the `start_config.cmd` file.** ### Building @@ -102,7 +101,6 @@ You can find the output jar in the root of the project folder. # Quick Troubleshooting -* If compiling wasn't successful, please check your JDK installation (Make sure its JDK 17 or higher and validated JDK's bin PATH variable) -* My client doesn't connect, doesn't login, 4206, etc... - Mostly your proxy daemon setup is *the issue*, if using - Fiddler make sure it running on another port except 8888 +* If compiling wasn't successful, please check your JDK installation (Make sure its JDK 17 or higher and validated JDK's bin PATH variable). +* My client doesn't connect, doesn't login, 4206, etc... - Mostly your proxy daemon setup is *the issue*. If you're using Fiddler, change the default port to anything other than 8888. * Startup sequence: MongoDB > Grasscutter > Proxy Daemon (mitmdump, fiddler, etc.) > Game diff --git a/README_fil-PH.md b/README_fil-PH.md index e80ab83ac..735a097b3 100644 --- a/README_fil-PH.md +++ b/README_fil-PH.md @@ -7,11 +7,9 @@ **Atensyon:** Ang mga kontributor ay laging welcome sa proyektong ito. Bago mag-bigay ng kontribusyon, basahin muna ng mabuti ang [Code of Conduct](https://github.com/Grasscutters/Grasscutter/blob/stable/CONTRIBUTING.md). -(Basahin ha, hindi titingin lang) +## Ang mga kasalukuyang features -## Ang mga current features - -* Login system +* Logging in * Combat * Friends list * Teleportation @@ -22,62 +20,61 @@ ## Quick setup guide -**Atensyon:** Kung di mo talaga kaya o hindi mo maintindihan ang wiki, maaari kang sumali sa aming server [Discord](https://discord.gg/T5vZU6UyeG). +**Atensyon:** Para sa mga nangangailangan ng suporta, maaari kang sumali sa aming server [Discord](https://discord.gg/T5vZU6UyeG). ### Ang mga kailangan -* Java SE - 17 ([link](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)) +* [Java SE - 17](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) or higher - **Atensyon:** Kung gusto mo lang **paganahin** ang server, then **jre** is pwede naman. + **Atensyon:** Kung gusto mo lang **paganahin** ang server, pwede naman ang **jre**. * [MongoDB](https://www.mongodb.com/try/download/community) (recommended 4.0+) -* Proxy daemon: mitmproxy (mitmdump, recommended), Fiddler Classic, etc. +* Proxy Daemon: [mitmproxy](https://mitmproxy.org/) (mitmdump, recommended), [Fiddler Classic](https://telerik-fiddler.s3.amazonaws.com/fiddler/FiddlerSetup.exe), etc. ### Running -**Atensyon:** Kung nag-update ka galing sa old version, paki-delete ang `config.json` para mag-regenerate ulit. +**Atensyon:** Kung nag-update ka galing sa lumang version, paki-delete ang `config.json` para mag-regenerate ulit. 1. Get `grasscutter.jar` - - Download ka from [actions](https://github.com/Grasscutters/Grasscutter/suites/6895963598/artifacts/267483297) - - [Build mo ung jar by yourself](#Building) -2. Gawa ka ng `resources` folder sa directory kung nasaan ang grasscutter.jar at ilagay ang `BinOutput` at `ExcelBinOutput` sa loob ng resources folder *(Check mo ang [wiki](https://github.com/Grasscutters/Grasscutter/wiki) para malaman mo san mo makukuha yan)* -3. Paandarin ang Grasscutter gamit ang command na `java -jar grasscutter.jar`. **Make sure na gumagana ang mongodb (Google mo nalang kung pano mo malalaman)** + - I-download mo sa [releases](https://github.com/Grasscutters/Grasscutter/releases/latest) o sa [actions](https://github.com/Grasscutters/Grasscutter/actions/workflows/build.yml) o [bumuo ng iyong sariling server](#building). +2. Gawa ka ng `resources` folder sa directory kung nasaan ang grasscutter.jar at ilagay ang `BinOutput, ExcelBinOutput, Readables, Scripts, Subtitle, TextMap` folders sa loob ng resources folder *(Tingnan mo ang [wiki](https://github.com/Grasscutters/Grasscutter/wiki) para malaman mo kung saan mo makukuha yan)* +3. Paandarin ang Grasscutter gamit ang command na `java -jar grasscutter.jar`. **Siguraduhin mo na ang mongodb service ay naka-open din.** ### Connecting with the client -½. Create ka ng account gamit ang [server console command](https://github.com/Grasscutters/Grasscutter/wiki/Commands#targeting). +½. Gumawa ng account sa server console gamit ang [command](https://github.com/Grasscutters/Grasscutter/wiki/Commands#:~:text=account%20%3Ccreate|delete%3E%20%3Cusername%3E%20[UID]) na ito. -1. Redirect traffic: (choose one) +1. Redirect traffic: (pumili lang dapat ng isa) - mitmdump: `mitmdump -s proxy.py -k` - Trust CA certificate: + - Trust CA certificate: - ​ **Note:** Usually ang CA certificate ay nakalagay sa `%USERPROFILE%\ .mitmproxy`, o pwede mo naman i-download from `http://mitm.it` + - Ang CA certificate ay nasa `%USERPROFILE%\.mitmproxy`, i-double click ang `mitmproxy-ca-cert.cer` para ma-[install](https://docs.microsoft.com/en-us/skype-sdk/sdn/articles/installing-the-trusted-root-certificate#installing-a-trusted-root-certificate) o... - ​ Double click para ma-[install](https://docs.microsoft.com/en-us/skype-sdk/sdn/articles/installing-the-trusted-root-certificate#installing-a-trusted-root-certificate) or ... + - Via command line *(kailangan ng administration privileges)* - - Gamit ang command line (cmd.exe) + ```shell + certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer + ``` - ```shell - certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer - ``` + - Fiddler Classic: Paadarin ang Fiddler Classic, turn on mo yung `Decrypt https traffic` sa (Tools -> Options -> HTTPS) at baguhin mo ang default port na nakalagay (Tools -> Options -> Connections) sa anumang numero maliban sa `8888`, i-load ang [script](https://github.com/Grasscutters/Grasscutter/wiki/Resources#fiddler-classic-jscript) na ito (copy and paste ang script sa `FiddlerScript` tab) at i-click ang `Save Script` button. - - Fiddler Classic: Paadarin ang Fiddler Classic, tsaka turn on mo yung `Decrypt https traffic` sa settings at baguhin mo yung default port na nakalagay (Tools -> Options -> Connections) to anything other than `8888`, at saka mo i-load [itong script](https://github.lunatic.moe/fiddlerscript). - - - [Hosts file](https://github.com/Grasscutters/Grasscutter/wiki/Running#traffic-route-map) + - [Hosts file](https://github.com/Grasscutters/Grasscutter/wiki/Resources#hosts-file) 2. Set mo ung proxy sa `127.0.0.1:8080` or dun sa proxy port na iyong inilagay. -**pwede mo rin gamitin ang `start.cmd` to start the servers and proxy daemons automatically, pero kailagan mong i-setup ang JAVA_HOME enviroment** +- Para sa mitmproxy: Pagkatapos mong i-setup ang network proxy at sa pag-install ng certificate, tingnan mo sa http://mitm.it/ kung ang traffic ay dumadaan sa mitmproxy. + +**Pwede mo rin gamitin ang `start.cmd` to start the servers and proxy daemons automatically, pero kailagan mong i-setup ang JAVA_HOME environment at i-configure ang `start_config.cmd` file.** ### Building -Ang Grasscutter ay gumagamit ng gradle for depedencies at building. +Ang Grasscutter ay gumagamit ng Gradle para sa depedencies at building. **Mga kailangan:** -- [Java SE Development Kits - 17](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) +- [Java SE Development Kits - 17](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) or higher - [Git](https://git-scm.com/downloads) ##### Windows @@ -98,17 +95,12 @@ chmod +x gradlew ./gradlew jar # Compile jar ``` -Pag-katapos mong i-compile, check mo yung [project](https://github.com/grasscutters/grasscutter) directory at saka makikita mo ung jar na kinompile mo. Usually pag-dev version, ang dapat nakalagay jan ay `grasscutter--dev.jar`. Bulag ka pag-hindi mo pa yan nakita. +Pag-katapos mong i-compile, check mo yung project directory at makikita mo yung jar na kinompile mo. Usually pag-dev version, ang dapat nakalagay diyan ay `grasscutter--dev.jar`. -### Atensyon: ang mga server commands ay nasa [wiki](https://github.com/Grasscutters/Grasscutter/wiki/Commands)! +### Ang mga server commands ay nasa [wiki](https://github.com/Grasscutters/Grasscutter/wiki/Commands) na! # Quick Troubleshooting -* Kung hindi nag-compile, paki-check ung JDK installation mo (JDK 17 at JDK's bin PATH variable). Pag-hindi mo pa rin na-compile o hindi mo ma-gets, isa lang masasabi ko sayo, may skill issue+reading issue ka. -* Hindi ako maka-connect, ayaw mag-login, 4206, etc... - `Usually proxy may kasalanan nyan`, ito ung pinaka-malalang skill issue na pwede mong makuha, sa lahat ng problems sa gc. Kung ayaw mo nyan, basahin mo ito. - -Kung Fiddler user ka, paki-sigurado na naka-set ung port sa kahit ano except sa `8888`. (8888 port is for hoyoverse spider logs, in case na hindi mo alam) -* Startup sequence: MongoDB > Grasscutter > Proxy daemon o Proxy service (mitmdump, fiddler, etc.) - - KUNG HINDI MO TALAGA MAINTINDIHAN, LUMAYAS KA NA DITO......... -PUTANG INA MO, TAGLISH NA NGA YAN. TAS HINDI MO PA MA-GETS LMAO \ No newline at end of file +* Kung hindi nag-compile, paki-check ung JDK installation mo (JDK 17 at JDK's bin PATH variable). +* Hindi ako maka-connect, ayaw mag-login, 4206, etc... - Mostly ang proxy setup mo ang may kasalanan niyan, kung gamit mo ay Fiddler, paki-sigurado na naka-set ung port sa kahit ano except sa 8888. +* Ang pagkakasunud-sunod: MongoDB > Grasscutter > Proxy Daemon (mitmdump, fiddler, etc.) > Game