From 5499328839baa5ffc0a8301d11232086ca0ff015 Mon Sep 17 00:00:00 2001 From: Natsu Date: Thu, 20 Mar 2025 12:36:09 +0700 Subject: [PATCH] docs: Update README with documentation link and remove installation instructions This commit updates the README.md file to include a link to the project's documentation and removes the detailed installation instructions. The installation instructions are now available on the documentation site. --- README.md | 71 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index c7326337..19076383 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -[![](https://img.shields.io/endpoint?url=https://hits.dwyl.com/NatsumeLS/Gakumas-Translation-Data-EN.json?color=pink&style=flat-square&label=Views)](https://github.com/NatsumeLS/Gakumas-Translation-Data-EN/graphs/traffic) [![](https://img.shields.io/github/actions/workflow/status/NatsumeLS/Gakumas-Translation-Data-EN/check.yml?style=flat-square&label=Check)](https://github.com/NatsumeLS/Gakumas-Translation-Data-EN/actions/workflows/check.yml) [![](https://dcbadge.limes.pink/api/server/https://discord.gg/qARc4Hdc3n)](https://natsume.io/GakumasLocalize) @@ -7,74 +6,8 @@ - Localization Data for [gakuen-imas-localify](https://github.com/chinosk6/gakuen-imas-localify) - # Bind your gakumas account to your `BNID` account first before attempting to install the patch - -# How to install the localify app - -## Getting started - -Get Latest Build https://github.com/chinosk6/gakuen-imas-localify/releases -For Root users use `LSPosed` https://github.com/LSPosed/LSPosed -For Non-Root users use built-in patching method in the localify app - -`LSPatch` is an alternative to `LSPosed` and is used for applying patches to your Android system. It does not require root access, which makes it a popular choice for users who do not want to root their devices. - -Instructions for `LSPosed` won't be provided here since it is unique for each devices. - -## Instructions for Installing `gakuen-imas-localify` using `Shizuku` - -# Installing the patch via `LSPatch` &`Shizuku` -### Step 1: Install Shizuku - -- Install `Shizuku` from Google Play Store. -- Open `Shizuku` and follow the instructions to start the service. - -### Step 2: Install `LSPatch` - -- Visit `LSPatch` https://github.com/JingMatrix/LSPatch GitHub repository to download the latest APK. -- Install `LSPatch` on your device. - -### Step 3: Configure `LSPatch` with Shizuku - -- Open `Shizuku` and ensure the service is running. -- Open `LSPatch` -- You should see a prompt to grant Shizuku permissions. -- Follow the on-screen instructions to grant the necessary permissions. - -### Step 4: Use `LSPatch` - -- Install `Gakumas-Localify` -- Open `LSPatch` and navigate to the second tab where you can add apps. -- Add new patch and select `学マス` then follow the instructions to apply patches. -- Only use `Local Patch Mode` -- Make sure the Module is enabled in `LSPatch` -- Also make sure that `学マス` is enabled in `Module Scopes` - -# TRANSLATION DATA - -# Installing the translation data - -- Make sure `Enable plugin` is toggled on in the `Basic settings` tab -- Disable `Check Built-in Asset Update` -- Make sure `Force Update Resource` is disabled in the `Advanced` tab -- Make sure `replace font` and `fast initialization` are disabled -- Make sure `MasterDB localization` in the advanced tab of `gakuen-imas-localify` are enabled -- Enable `Use Remote ZIP Resource` in the `resource settings` tab and enter **`https://github.com/NatsumeLS/Gakumas-Translation-Data-EN.git`** -- Download the translation data - -> # If the translations still have partially chinese TL, Run the game once with `delete plugin resource` enabled and then run the game again with `use remote zip resource` to reinstall the EN translation data - -# Updating the translation data -Update the translation datas via the `resource settings` tab in the `gakuen-imas-localify` app. -Any updates made to the translation datas will be visible in #en-translation-data - -# Updating the game via pre-patched APKs - -Install the latest game version available here: -https://github.com/Kajaqq/gaku-patcher/releases - -By using this, you wont have to patch the game manually again via localify or lspatch. -It is recommended to still patch your game at least once manually when you first started the process. +## Documentation +https://gakumas.natsume.io ## Files and Folder Structure