You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/misc/handbook-contribution.md
+9-29Lines changed: 9 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,16 +16,13 @@ The Warudo handbook proudly uses [Docusaurus](https://docusaurus.io/) as site fr
16
16
17
17
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!
18
18
19
-
20
19
## How to Contribute
21
20
22
21
### Provide Feedback and Suggestions via GitHub Issues
23
22
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 .
26
24
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 .
29
26
30
27
### Submit Code and Become a Contributor
31
28
@@ -52,8 +49,6 @@ It's recommended to copy every file in `/docs` folder to `/i18n/[lang]/docusauru
52
49
53
50
:::
54
51
55
-
56
-
57
52
### Commands
58
53
59
54
| Command | Description |
@@ -65,50 +60,40 @@ It's recommended to copy every file in `/docs` folder to `/i18n/[lang]/docusauru
65
60
|`yarn start:all`| Start multi-version at different port |
66
61
|`yarn build`| Build site |
67
62
68
-
69
63
## Running local development site
70
64
71
65
If you are not familiar with dev staff, don't worry, let's get start.
<small>So that you can edit files in your independent branch.</small>
111
-
112
97
- Click `Publish branch`
113
98
<small>Event one should see your branch and you are ready to start edit.</small>
114
99
@@ -118,15 +103,12 @@ Open the terminal.
118
103
119
104
-**`cd <path_for_your_dev_folder>`**
120
105
<small>Jump into the folder where we place site files.</small>
121
-
122
-
-**`corepack enable`**
106
+
-**`corepack enable`**
123
107
<small>That set up package manager we used for node.js.</small><br />
124
108
<small>*Usually you just need run this command once.*</small>
125
-
126
109
-**`yarn`**
127
110
<small>Install dependencies.</small><br />
128
111
<small>*When project dependencies (package.json) updated, re-run this command is necessary.*</small>
129
-
130
112
-**`yarn start:en`** Start EN version
131
113
**`yarn start:zh`** Start ZH version
132
114
**`yarn start:all`** Start multi-version at different port
@@ -139,22 +121,19 @@ Try it out, and go ahead start editing document files!
139
121
140
122
- Edit markdown files and check live page in browser
141
123
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,
143
125
which is just plain text with some formate code in it.
144
126
145
127
### Commit & Upload your changes
146
128
147
-
After saving all the files that you changed.
129
+
After saving all the files that you changed.
148
130
149
131
- Open the Github desktop, then you can see all the changes on the left side.
150
132
Check all the changed files you want to commit.
151
-
Enter a summary, and click `Commit`.
152
-
133
+
Enter a summary, and click `Commit`.
153
134
- You have committed your changes and you should see it in the `History` panel.
154
-
155
135
- But it is just on your computer right now.
156
136
To publish to Github, click `Push Origin`.
157
-
158
137
- Yay! Everyone should see it on github.
159
138
160
139
### Contact Warudo Handbook Maintenance Members for Review and Publication
@@ -166,6 +145,7 @@ After saving all the files that you changed.
166
145
## Add Your Own Name
167
146
168
147
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.
Copy file name to clipboardExpand all lines: docs/modding/sdk-installation.md
+29-25Lines changed: 29 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
sidebar_position: 1
3
-
version: 2026-01-13
3
+
version: 2026-01-14
4
4
---
5
5
6
6
# Unity & Warudo SDK Installation
@@ -22,7 +22,7 @@ Unity Hub is a software used to manage different versions of the Unity Editor an
22
22
23
23
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.
24
24
25
-

25
+

26
26
27
27
Run the downloaded UnityHubSetup.exe and install it to your preferred path.
28
28
After installation, confirm that it can be opened correctly.
@@ -56,31 +56,32 @@ You can change the language of Unity Hub in 【Preferences】-【Appearance】.
56
56
57
57
## Step 2 - Install Unity Editor
58
58
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**.
60
60
61
61
This specific patch release is required for compatibility with the Warudo SDK and cannot be substituted. To install it:
62
62
63
63
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**;
68
66

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.
69
70
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:**
77
72
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
+

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**.
82
83
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.
84
85
85
86

86
87
@@ -96,7 +97,8 @@ We strongly recommend the Package Manager method because it makes it easy to kee
96
97
97
98
### Method A — Unity Package Manager (recommended)
98
99
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**)
100
102
101
103

102
104
@@ -106,16 +108,19 @@ Open your Unity project, then choose **Window → Package Manager**. In the Pack
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.
114
120
115
121
:::caution
116
122
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.
119
124

120
125
121
126
:::
@@ -124,7 +129,7 @@ If you see an error like `No 'git' executable was found. Please install Git on y
0 commit comments