Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion 404.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ layout: splash

<div class="notice--danger">
<h1 id="">404</h1>
<p><strong>页面不存在</strong></p>
<p><strong>页面不存在 · Page not found</strong></p>
<p><a href="/">简体中文</a> · <a href="/en/">English</a></p>
</div>
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Hello Minecraft! Launcher 帮助文档仓库

[Hello Minecraft! Launcher 帮助文档仓库网站](https://docs.hmcl.net)

[English documentation](https://docs.hmcl.net/en/)

## Markdown

每篇文章由 Markdown 编写。如果你不知道什么是 Markdown,我们推荐你先大概了解一下这个排版工具。
Expand Down Expand Up @@ -52,7 +54,30 @@ assets

### 更新索引

在添加或修改文章后,请更新索引文件 `index.json`,以便 HMCL 展示你新添加的文件。
在添加或修改文章后,请更新索引文件 `index.json`,以便 HMCL 展示你新添加的文件。默认语言(简体中文)的文章会自动同步到 `index.json`,翻译文章不会出现在其中。

### 多语言

本站默认语言为简体中文。英文翻译文件与中文原文放在同一目录下,文件名追加 `_en` 后缀即可:

```text
_launcher/isolation.md # 中文,输出 /launcher/isolation.html
_launcher/isolation_en.md # 英文,输出 /en/launcher/isolation.html
```

约定:

- 翻译文件的 front matter **不需要**写 `permalink`、`lang`、`locale`,`_plugins/i18n.rb` 会自动继承中文原文的 URL 并在前面加上 `/en`。
- 翻译文件需要翻译 `title`、`excerpt`/`description` 等元数据;`date`、`author`、`authors`、`layout` 等字段与原文保持一致。
- 翻译文件不要保留 `redirect_from`,避免中英文重定向路径冲突。
- 正文中的站内链接保持与中文原文相同的 URL 即可,构建时会自动改写为指向对应英文页面的链接(前提是该页面存在英文翻译)。
- 站点标题、描述与导航分别由 `_data/i18n.yml`、`_data/en/navigation.yml` 提供。新增语言时,需要:
1. 在 `_config.yml` 的 `i18n.locales` 中登记语言代码;
2. 在 `_data/i18n.yml` 中补充站点标题与描述;
3. 新建 `_data/<locale>/navigation.yml` 导航文件;
4. 用 `_<locale>` 后缀创建翻译文件。
- 页面标题栏右侧会显示语言切换入口,页面头部会自动输出 `hreflang` 标注。
- 更新日志(`_changelogs/`)目前只有中文内容,英文更新日志页面直接展示中文条目,并附带说明。

### 本地部署

Expand Down
13 changes: 13 additions & 0 deletions _changelog/dev_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: changelog
channel: dev
title: Changelogs for Development Versions
date: 2021-08-22 23:18:02 +0800
---

<!--{% comment %}-->
> [!NOTE]
> <!--{% endcomment %}-->
> Changelogs are written in Chinese.
<!----{{ '>' }}
{: .notice--info }
13 changes: 13 additions & 0 deletions _changelog/stable_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: changelog
channel: stable
title: Changelogs for Stable Versions
date: 2021-08-22 23:18:02 +0800
---

<!--{% comment %}-->
> [!NOTE]
> <!--{% endcomment %}-->
> Changelogs are written in Chinese.
<!----{{ '>' }}
{: .notice--info }
9 changes: 9 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,15 @@ defaults:
# Theme Settings
theme: minimal-mistakes-jekyll

# 多语言支持
# 默认语言的内容保持原有 URL;其他语言使用 `_<locale>` 文件名后缀,
# 由 _plugins/i18n.rb 自动生成 /<locale>/... 路径。
i18n:
default_locale: zh
locales:
- zh
- en

# Site Settings
locale: zh
# rtl:
Expand Down
11 changes: 11 additions & 0 deletions _data/en/groups.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name,link,status
HMCL User Group ① (633640264),https://qm.qq.com/q/fvJueufsvC,Full
HMCL User Group ② (203232161),https://qm.qq.com/q/N7hgdNYfy,
HMCL User Group ③ (201034984),https://qm.qq.com/q/7sbMrFm9CE,Full
HMCL User Group ④ (533529045),https://qm.qq.com/q/ACmZa98tGg,Full
HMCL User Group ⑤ (744304553),https://qm.qq.com/q/MlVArSCMwM,
HMCL User Group ⑥ (282845310),https://qm.qq.com/q/S782Skmu0U,Full
HMCL User Group ⑦ (482624681),https://qm.qq.com/q/WFsZ65F6MY,
HMCL User Group ⑧ (991620626),https://qm.qq.com/q/ECVKkslPqi,Full
HMCL User Group ⑨ (657677715),https://qm.qq.com/q/DVj9tTrwze,
HMCL User Group ⑩ (775084843),https://qm.qq.com/q/V5F9DswQEu,Full
63 changes: 63 additions & 0 deletions _data/en/navigation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
main:
- title: Settings
url: /en/settings.html

docs:
- title: Questions
children:
- title: FAQ
url: /en/faq.html
- title: Launcher Usage
url: /en/launcher/
- title: Modpack Help
url: /en/modpack/
- title: Multiplayer Help
url: /en/multiplayer/
- title: User Guide
children:
- title: Version Isolation
url: /en/launcher/isolation.html
description: This article helps you separate maps, mods and other content between game instances.
- title: Set an Offline Skin
url: /en/launcher/offline-skin.html
description: This article shows you how to set up your own offline skin.
- title: HMCL Auto-Installation Guide
url: /en/launcher/auto-installing.html
description: This article shows you how to use HMCL to install Forge, Fabric, Fabric API, LiteLoader, OptiFine, mods and more.
- title: Install Shaders
url: /en/launcher/shader.html
description: This article shows you how to install shaders.
- title: Settings Reference
url: /en/launcher/set-item-details.html
description: This article explains each HMCL setting in detail.
- title: Developer Guide
children:
- title: Create HMCL Datapacks
url: /en/launcher/datapack.html
description: This article shows you how to create datapacks that HMCL can recognize.
- title: Create a Modpack
url: /en/modpack/serverpack.html
description: This article shows you how to create a modpack.
- title: Add a Default authlib-injector Authentication Server
url: /en/launcher/authlib-injector.html
description: This article shows you how to configure a default authentication server.
- title: Changelogs
children:
- title: Stable
url: /en/changelog/stable.html
- title: Development
url: /en/changelog/dev.html
- title: Others
children:
- title: HMCL Verification
url: /en/verify.html
- title: User Agreement
url: /en/eula/hmcl.html
- title: Contributing Guide
url: /en/contribution.html
- title: Official Website
url: https://hmcl.huangyuhui.net
- title: Source Code
url: https://github.com/HMCL-dev/HMCL
- title: Documentation Repository
url: https://github.com/HMCL-dev/HMCL-docs
10 changes: 10 additions & 0 deletions _data/i18n.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# 站点级多语言信息,键为语言代码。
# 新增语言时,请同时补充对应语言的 _data/<locale>/navigation.yml。
zh:
name: 简体中文
title: HMCL 文档
description: HMCL 启动器 \| 跨平台 \| 整合包管理 \| 自动安装 \| 十二年历史 \| 三亿次使用
en:
name: English
title: HMCL Documentation
description: Hello Minecraft! Launcher \| Cross-platform \| Modpack management \| Automatic installation \| Twelve years of history \| 300 million uses
2 changes: 2 additions & 0 deletions _docs/contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ toc: false
如果你认为你有能力为 HMCL 添加高质量的帮助文档,或希望修改错误,你可以到 [https://github.com/HMCL-dev/HMCL-docs](https://github.com/HMCL-dev/HMCL-docs) 仓库中发 Pull Request,或者提 Issue。

或者你可以进入我们的 [Discord](https://discord.gg/jVvC7HfM6U) 或 [HMCL 用户群](/_docs/groups.md) 群以向 HMCL 反馈。

你也可以帮助我们把文档翻译成其他语言:在中文原文所在目录下创建 `<name>_en.md` 翻译文件并提交 Pull Request,具体约定请参阅仓库 README 的「多语言」一节。
13 changes: 13 additions & 0 deletions _docs/contribution_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Contributing Guide
date: 2021-10-09 23:18:02 +0800
author: huanghongxun
classes: wide
toc: false
---

If you believe you are capable of adding high-quality help documentation to HMCL, or would like to correct mistakes, you can submit a Pull Request or open an Issue in the [https://github.com/HMCL-dev/HMCL-docs](https://github.com/HMCL-dev/HMCL-docs) repository.

Alternatively, you can join our [Discord](https://discord.gg/jVvC7HfM6U) or the [HMCL User Group](/_docs/groups.md) to give feedback to HMCL.

You can also help us translate the documentation into other languages by creating a `<name>_en.md` file next to the original article and opening a Pull Request. See the "Multilingual" section of the repository README for the conventions.
96 changes: 96 additions & 0 deletions _docs/crash-support-group_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
title: Join the HMCL Crash Support Group
excerpt: The HMCL Crash Support Group only handles game errors and crashes
date: 2024-03-05 17:00:00 +0800
author: zkitefly
---

<!----{{'>'}}
<div id="alert-modal">
<div class="notice">
{% capture notice %}
<!---->
<h1 id="" align="center">Please Read Before Joining the Group</h1>

- If the game exits abnormally, please click the ![](/assets/img/docs/groups/button-1.png "Export Game Crash Logs") button in the lower left corner (not the ![](/assets/img/docs/groups/button-2.png "Logs") button), and send the complete crash archive that is generated
- If you encounter other problems, please describe the situation in detail and provide relevant screenshots so that we can help you
- When using a modpack, please state the specific modpack name and version
- Please be patient; the group administrators and other members will help solve your problem. Insulting or rushing others is strictly prohibited
- Do not discuss sensitive content such as politics, pornography, illegal activities, or monetary transactions; do not engage in personal attacks, rumor-mongering, or defamation
- Do not spam, flood the chat, start disputes, vent emotions, or engage in other behavior that disrupts the group chat
- Do not use third-party plugins to send special messages; do not discuss cheating tools for multiplayer games
- This group only supports HMCL-related issues. Users of the PCL launcher should join group 978054335
- Do not send the same file repeatedly. If you need to get attention again, quote your previously sent message
- Due to the member limit, users whose issues have been resolved will be removed from the group. You can join again if you encounter a new problem
- This group only handles game crash-related issues. Please discuss other topics in other groups

---
<!----{{'>'}}
{% endcapture %}
{{ notice | markdownify }}
<p class="text-center">Please wait <span id="countdown">5</span> seconds and read the notes carefully</p>
<button id="close-btn" class="btn align-center" disabled>I Understand</button>
</div>
</div>
<!---->

If you have encountered an abnormal game exit, you are welcome to join the crash support group for solutions: [Minecraft Crash Support Group (666546887)](https://qm.qq.com/q/nG0Ti1kJri)

![](/assets/img/docs/groups/crash.png)

**This group only handles game error and crash issues. Please take unrelated topics to other groups.**

Because too many people join, we remove users whose issues have been resolved. If you encounter a new problem after being removed and need help, you can join again.

<!----{{'>'}}
<style>
.initial-content {
position: relative;
z-index: 20;
}

#alert-modal {
position: fixed;
top: 0;
left: 0;
width: 100%;
height: 100%;
padding: 1em;
display: flex;
background: #00000090;
justify-content: center;
align-items: center;
z-index: 20;
}
#alert-modal img {
vertical-align: middle;
margin-block: -0.5em;
display: inline;
height: 2.5em;
}
</style>
<script>
document.addEventListener("DOMContentLoaded", function () {
var modal = document.getElementById("alert-modal");
var show = localStorage.getItem("crash-support-group.show");
if (show === "1") {
modal.style.display = "none";
return;
}
var text = document.getElementById("countdown");
var btn = document.getElementById("close-btn");
var sec = parseInt(text.textContent, 10) || 10;
var timer = setInterval(function () {
text.textContent = --sec;
if (sec <= 0) {
clearInterval(timer);
text.parentNode.textContent = "Please click the button below to close";
btn.disabled = false;
}
}, 1000);
btn.addEventListener("click", function () {
localStorage.setItem("crash-support-group.show", "1");
modal.style.display = "none";
}, false);
});
</script>
Loading