Skip to content

Commit 5049d38

Browse files
authored
Merge pull request #115 from hanekit/master
Multiple updates
2 parents f85348c + e819492 commit 5049d38

File tree

19 files changed

+396
-112
lines changed

19 files changed

+396
-112
lines changed

docs/misc/handbook-contribution.md

Lines changed: 9 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,13 @@ The Warudo handbook proudly uses [Docusaurus](https://docusaurus.io/) as site fr
1616

1717
The Warudo handbook is open-source project. If you find anything hard to understand or want to provide new content, such as tutorials or guidance, feel free to create issues on GitHub, or directly contribute by submitting code or translations to the GitHub project. Your name will appear in the contributors list at the bottom of the documentation!
1818

19-
2019
## How to Contribute
2120

2221
### Provide Feedback and Suggestions via GitHub Issues
2322

24-
Providing feedback directly through GitHub Issues is a straightforward and simple way. We have set up some issue templates to help submit issues.<br />
25-
https://github.com/HakuyaLabs/warudo-docs/issues
23+
Providing feedback directly through GitHub Issues is a straightforward and simple way. We have set up some issue templates to help submit issues: https://github.com/HakuyaLabs/warudo-docs/issues .
2624

27-
tips: The feedback here is for the Warudo handbook site. For discussions about the Warudo software itself, feel free to join Discord channels.<br />
28-
https://discord.gg/warudo
25+
Tip: The feedback here is for the Warudo handbook site. For discussions about the Warudo software itself, feel free to join Discord channels: https://discord.gg/warudo .
2926

3027
### Submit Code and Become a Contributor
3128

@@ -52,8 +49,6 @@ It's recommended to copy every file in `/docs` folder to `/i18n/[lang]/docusauru
5249

5350
:::
5451

55-
56-
5752
### Commands
5853

5954
| Command | Description |
@@ -65,50 +60,40 @@ It's recommended to copy every file in `/docs` folder to `/i18n/[lang]/docusauru
6560
| `yarn start:all` | Start multi-version at different port |
6661
|`yarn build` | Build site |
6762

68-
6963
## Running local development site
7064

7165
If you are not familiar with dev staff, don't worry, let's get start.
7266

73-
7467
<details>
75-
7668
<summary>Document development tutorial</summary>
7769

7870
### Prepare environment
7971

80-
First, download the runtime.
72+
First, download the runtime.
8173

8274
- Node.js download: https://nodejs.org/en/download/
8375
<small>Node.js is the programming language we used. </small> <br />
84-
<small>Select LTS version - installer (.msi/.exe for Windows, .pkg for macOS).</small>
85-
76+
<small>Select LTS version - installer (.msi/.exe for Windows, .pkg for macOS).</small>
8677
- GitHub Desktop download: https://desktop.github.com/
8778
<small>GitHub Desktop is a great version control software for us to manage and commit changes.</small>
88-
8979
- VSCode download: https://code.visualstudio.com/
9080
<small>VSCode is a common editor that works great for front-end sites like this one, you can also use other text editors.</small>
9181

9282
### Using command line
9383

9484
- For Windows, use `Win+R` and enter `cmd` to open the terminal.
95-
9685
- For macOS, use the `Terminal` app in your lunchpad.
9786

9887
After installation, you should able to use the `node -v` command to see node.js version on the terminal.
9988

10089
### Set up the project using GitHub desktop
10190

10291
- Login Github account
103-
10492
- Search for `HakuyaLabs/warudo-docs`
105-
10693
- Clone project
10794
<small>Then the project has been downloaded to your computer.</small>
108-
10995
- Click `Current branch` - `New branch` - input name - `Create branch`
11096
<small>So that you can edit files in your independent branch.</small>
111-
11297
- Click `Publish branch`
11398
<small>Event one should see your branch and you are ready to start edit.</small>
11499

@@ -118,15 +103,12 @@ Open the terminal.
118103

119104
- **`cd <path_for_your_dev_folder>`**
120105
<small>Jump into the folder where we place site files.</small>
121-
122-
- **`corepack enable`**
106+
- **`corepack enable`**
123107
<small>That set up package manager we used for node.js.</small><br />
124108
<small>*Usually you just need run this command once.*</small>
125-
126109
- **`yarn`**
127110
<small>Install dependencies.</small><br />
128111
<small>*When project dependencies (package.json) updated, re-run this command is necessary.*</small>
129-
130112
- **`yarn start:en`** Start EN version
131113
**`yarn start:zh`** Start ZH version
132114
**`yarn start:all`** Start multi-version at different port
@@ -139,22 +121,19 @@ Try it out, and go ahead start editing document files!
139121

140122
- Edit markdown files and check live page in browser
141123

142-
Most document files are saved as .md or .mdx, known as [Markdown](https://www.markdownguide.org/) files,
124+
Most document files are saved as .md or .mdx, known as [Markdown](https://www.markdownguide.org/) files,
143125
which is just plain text with some formate code in it.
144126

145127
### Commit & Upload your changes
146128

147-
After saving all the files that you changed.
129+
After saving all the files that you changed.
148130

149131
- Open the Github desktop, then you can see all the changes on the left side.
150132
Check all the changed files you want to commit.
151-
Enter a summary, and click `Commit`.
152-
133+
Enter a summary, and click `Commit`.
153134
- You have committed your changes and you should see it in the `History` panel.
154-
155135
- But it is just on your computer right now.
156136
To publish to Github, click `Push Origin`.
157-
158137
- Yay! Everyone should see it on github.
159138

160139
### Contact Warudo Handbook Maintenance Members for Review and Publication
@@ -166,6 +145,7 @@ After saving all the files that you changed.
166145
## Add Your Own Name
167146

168147
At the bottom of each document, there is a section of code that marks the editors of the document. When you modify or complete a document, don't forget to add your name here. The avatar will be automatically fetched through your GitHub ID.
148+
169149
```
170150
<AuthorBar authors={{
171151
creators: [

docs/modding/sdk-installation.md

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
sidebar_position: 1
3-
version: 2026-01-13
3+
version: 2026-01-14
44
---
55

66
# Unity & Warudo SDK Installation
@@ -22,7 +22,7 @@ Unity Hub is a software used to manage different versions of the Unity Editor an
2222

2323
Open the [**Unity official website**](https://unity.com/download) and click one of the two red boxes in the image below to download Unity Hub. Downloading may require registering a Unity account.
2424

25-
![](/doc-img/sdk-installation-13.png)
25+
![](/doc-img/en-sdk-installation-1.png)
2626

2727
Run the downloaded UnityHubSetup.exe and install it to your preferred path.
2828
After installation, confirm that it can be opened correctly.
@@ -56,31 +56,32 @@ You can change the language of Unity Hub in 【Preferences】-【Appearance】.
5656

5757
## Step 2 - Install Unity Editor
5858

59-
Next, you need to download the installer of Unity Editor, and the version must strictly be **Unity 2021.3.45f2**.
59+
Next, you need to download the installer of Unity Editor, and the version must strictly be **2021.3.45f2**.
6060

6161
This specific patch release is required for compatibility with the Warudo SDK and cannot be substituted. To install it:
6262

6363
1. Go to [Unity Download Archive](https://unity.com/releases/editor/archive);
64-
2. Under the **Unity 2021.X** tab, find **Unity 2021.3.45f2 (3 Oct, 2025)**;
65-
3. Click **Downloads (Win)**;
66-
4. Select **Unity Editor (64-bit)** and download the installer (file name similar to `UnitySetup 64-2021.3.45f2.exe`, ~2–3 GiB);
67-
64+
2. Under the **2021** tab, find Version **2021.3.45f2 (Oct 3, 2025)**;
65+
3. Click **INSTALL**;
6866
![](/doc-img/sdk-installation-9.png)
67+
4. The browser will try to open your Unity Hub, choose **Open**;
68+
5. In the opened Unity Hub window, click **Continue**, then click **Install**;
69+
6. The installation can take a long time, please be patient.
6970

70-
Run the downloaded installer to start installation.
71-
72-
The default installation location may be `C:\Program Files\Unity 2021.3.45f2`; you may change it, but we recommend including the version number in the path (for example `D:\Softwares\Unity\2021.3.45f2`) to avoid confusion when managing multiple Unity versions.
73-
74-
The installation can take a long time; please be patient.
75-
76-
After installation:
71+
**If `4.` failed or you want to install it manually, back to `2.` , then:**
7772

78-
1. Open Unity Hub;
79-
2. Go to **Installs → Locate**;
80-
3. Browse to the editor folder you installed and select `Unity.exe` inside the `Editor` subfolder;
81-
4. Click **Select Editor**.
73+
3. Click **See all**;
74+
4. Click **Windows** to download the installer (file name similar to `UnitySetup64-2021.3.45f2.exe`, ~3–4 GiB);
75+
![](/doc-img/sdk-installation-13.png)
76+
5. Run the downloaded installer to start installation.
77+
The default installation location may be `C:\Program Files\Unity 2021.3.45f2`; you may change it, but we recommend including the version number in the path (for example `D:\Softwares\Unity\2021.3.45f2`) to avoid confusion when managing multiple Unity versions.
78+
The installation can take a long time, please be patient.
79+
6. After installation: Open Unity Hub;
80+
7. Go to **Installs → Locate**;
81+
8. Browse to the editor folder you installed and select `Unity.exe` inside the `Editor` subfolder;
82+
9. Click **Select Editor**.
8283

83-
The selected Unity version (2021.3.45f2) should now appear in Unity Hub.
84+
After the above steps, the required Unity version (2021.3.45f2) should now appear in Unity Hub.
8485

8586
![](/doc-img/sdk-installation-10.png)
8687

@@ -96,7 +97,8 @@ We strongly recommend the Package Manager method because it makes it easy to kee
9697

9798
### Method A — Unity Package Manager (recommended)
9899

99-
Before installation, confirm **File → Build Settings... → Player Settings... → Other Settings → Api Compatibility Level** (also accessible via **Edit → Project Settings → Player → Other Settings**) is set to **.NET Framework**, and **Assembly Version Validation** is unchecked.
100+
Before installation, confirm **File → Build Settings... → Player Settings... → Other Settings → Api Compatibility Level** is set to **.NET Framework**, and **Assembly Version Validation** is unchecked.
101+
(This page is also accessible via **Edit → Project Settings → Player → Other Settings**)
100102

101103
![](/doc-img/en-mod-sdk-2.webp)
102104

@@ -106,16 +108,19 @@ Open your Unity project, then choose **Window → Package Manager**. In the Pack
106108
https://github.com/HakuyaLabs/Warudo-Mod-Tool.git#0.14.3.5
107109
```
108110

109-
If you cannot access GitHub reliably, you can download a tarball and use **Add package from tarball...** instead:
111+
If you cannot access GitHub reliably, you can download a tarball:
110112

113+
<div className="file-box">
111114
<a href="/sdk/Warudo-Mod-Tool-0.14.3.5.tgz" target="_blank">Warudo-Mod-Tool-0.14.3.5.tgz</a>
115+
</div>
116+
117+
and use **Add package from tarball...** instead.
112118

113119
Click **Add** and Unity will download and install the package. If Unity prompts about prebuilt packages or conversion, choose **Yes** and wait for the package to import.
114120

115121
:::caution
116122

117-
If you see an error like `No 'git' executable was found. Please install Git on your system then restart Unity and Unity Hub`, then Git is not installed on your system. Install Git from https://git-scm.com/download, then restart Unity and Unity Hub.
118-
123+
If you see an error like `No 'git' executable was found. Please install Git on your system then restart Unity and Unity Hub`, then Git is not installed on your system. Install Git from https://git-scm.com/download, then restart Unity and Unity Hub.
119124
![](/doc-img/en-mod-sdk-1.webp)
120125

121126
:::
@@ -124,7 +129,7 @@ If you see an error like `No 'git' executable was found. Please install Git on y
124129

125130
[Warudo SDK 0.14.3.5 Modding Project.zip](https://files.warudo.app/modsdk/Warudo%20SDK%200.14.3.5%20Modding%20Project.zip)
126131

127-
1. Download and extract the zip to a folder (for example `D:\Softwares\Unity\2021.3.45f2\Projects\WarudoModding`).
132+
1. Download and extract the above zip to a folder (for example `D:\Softwares\Unity\2021.3.45f2\Projects\WarudoModding`).
128133
2. In Unity Hub click **Add** (or **Open**) and select that folder.
129134
3. Open the project. Unity may take several minutes to import assets on the first run.
130135

@@ -156,6 +161,5 @@ If everything imported without Errors, you can start with [creating your first m
156161
{name: 'hanekit', github: 'hanekit'}
157162
],
158163
translators: [
159-
{name: 'hanekit', github: 'hanekit'}
160164
],
161165
}} />

0 commit comments

Comments
 (0)