Skip to content

Commit 5499328

Browse files
committed
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.
1 parent f88e8d4 commit 5499328

File tree

1 file changed

+2
-69
lines changed

1 file changed

+2
-69
lines changed

README.md

+2-69
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
[![](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)
21
[![](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)
32

43
[![](https://dcbadge.limes.pink/api/server/https://discord.gg/qARc4Hdc3n)](https://natsume.io/GakumasLocalize)
@@ -7,74 +6,8 @@
76

87
- Localization Data for [gakuen-imas-localify](https://github.com/chinosk6/gakuen-imas-localify)
98

10-
# Bind your gakumas account to your `BNID` account first before attempting to install the patch
11-
12-
# How to install the localify app
13-
14-
## Getting started
15-
16-
Get Latest Build https://github.com/chinosk6/gakuen-imas-localify/releases
17-
For Root users use `LSPosed` https://github.com/LSPosed/LSPosed
18-
For Non-Root users use built-in patching method in the localify app
19-
20-
`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.
21-
22-
Instructions for `LSPosed` won't be provided here since it is unique for each devices.
23-
24-
## Instructions for Installing `gakuen-imas-localify` using `Shizuku`
25-
26-
# Installing the patch via `LSPatch` &`Shizuku`
27-
### Step 1: Install Shizuku
28-
29-
- Install `Shizuku` from Google Play Store.
30-
- Open `Shizuku` and follow the instructions to start the service.
31-
32-
### Step 2: Install `LSPatch`
33-
34-
- Visit `LSPatch` https://github.com/JingMatrix/LSPatch GitHub repository to download the latest APK.
35-
- Install `LSPatch` on your device.
36-
37-
### Step 3: Configure `LSPatch` with Shizuku
38-
39-
- Open `Shizuku` and ensure the service is running.
40-
- Open `LSPatch`
41-
- You should see a prompt to grant Shizuku permissions.
42-
- Follow the on-screen instructions to grant the necessary permissions.
43-
44-
### Step 4: Use `LSPatch`
45-
46-
- Install `Gakumas-Localify`
47-
- Open `LSPatch` and navigate to the second tab where you can add apps.
48-
- Add new patch and select `学マス` then follow the instructions to apply patches.
49-
- Only use `Local Patch Mode`
50-
- Make sure the Module is enabled in `LSPatch`
51-
- Also make sure that `学マス` is enabled in `Module Scopes`
52-
53-
# TRANSLATION DATA
54-
55-
# Installing the translation data
56-
57-
- Make sure `Enable plugin` is toggled on in the `Basic settings` tab
58-
- Disable `Check Built-in Asset Update`
59-
- Make sure `Force Update Resource` is disabled in the `Advanced` tab
60-
- Make sure `replace font` and `fast initialization` are disabled
61-
- Make sure `MasterDB localization` in the advanced tab of `gakuen-imas-localify` are enabled
62-
- Enable `Use Remote ZIP Resource` in the `resource settings` tab and enter **`https://github.com/NatsumeLS/Gakumas-Translation-Data-EN.git`**
63-
- Download the translation data
64-
65-
> # 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
66-
67-
# Updating the translation data
68-
Update the translation datas via the `resource settings` tab in the `gakuen-imas-localify` app.
69-
Any updates made to the translation datas will be visible in #en-translation-data
70-
71-
# Updating the game via pre-patched APKs
72-
73-
Install the latest game version available here:
74-
https://github.com/Kajaqq/gaku-patcher/releases
75-
76-
By using this, you wont have to patch the game manually again via localify or lspatch.
77-
It is recommended to still patch your game at least once manually when you first started the process.
9+
## Documentation
10+
https://gakumas.natsume.io
7811

7912
## Files and Folder Structure
8013

0 commit comments

Comments
 (0)