diff --git a/README-en.md b/README-en.md new file mode 100644 index 000000000..63d4c92a1 --- /dev/null +++ b/README-en.md @@ -0,0 +1,39 @@ +# SuperbWarfare + +[中文](./README.md) | **[English](./README-en.md)** + +## Introduction + +A "Superb" military-themed Minecraft Mod. + +(Currently in development. Weapon stats may change. If encountering issues like inability to fire, drop the weapon on +ground and pick it up again to reset data) + +## Installation Guide + +1. Ensure using Minecraft version 1.20.1 +2. Ensure Forge 47.2.0 or above is installed +3. Ensure Curios Api mod 5.4.2-1.20.1 or above is installed +4. Ensure Geckolib mod 4.4.4-1.20.1 or above is installed +5. Place the mod jar file into mods folder + +## Integration + +Install Cloth Config mod 11.1.106-1.20.1 or above to enable in-game configuration adjustments. + +## License + +The code portion of this mod is open-sourced under GPL-3.0 license. + +All models, textures and other resources (except specially marked ones) are owned by the development team. Unauthorized +use without permission is prohibited. + +## Links + +[CurseForge](https://www.curseforge.com/minecraft/mc-mods/superb-warfare) + +[Modrinth](https://modrinth.com/mod/superb-warfare) + +[Github](https://github.com/Mercurows/SuperbWarfare) + +[Gitee](https://gitee.com/atsuishio/SuperbWarfare) diff --git a/README.md b/README.md index 237c749a0..68ec23397 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ # SuperbWarfare / 卓越前线 -#### 介绍 +**[中文](./README.md)** | [English](./README-en.md) + +## 介绍 + “卓越”的武装主题 Minecraft Mod。 + (目前仍在开发中,武器数据可能会有所改动,如遇到无法正常开火等情况,请将武器丢弃于地面再重新拾起重置数据) -#### 安装教程 +## 安装教程 1. 确保使用的Minecraft版本为 1.20.1; 2. 确保你为Minecraft安装了 47.2.0 及以上版本的 Forge; @@ -12,15 +16,17 @@ 4. 确保安装了 4.4.4-1.20.1 版本及以上的 Geckolib 模组; 5. 将模组jar文件放进mods文件夹。 -#### 联动 +## 联动 + 安装 11.1.106-1.20.1 版本及以上的 Cloth Config 模组,即可在游戏内调整配置。 -#### 协议 +## 协议 + 本模组的代码部分使用 GPL-3.0 协议进行开源。 模型、贴图等资源,除特殊标注外的,均归制作组所有,禁止在未获得制作组授权的情况下使用。 -#### 相关链接 +## 相关链接 [CurseForge](https://www.curseforge.com/minecraft/mc-mods/superb-warfare)