Skip to content

Commit

Permalink
docs: redirect doc (#142)
Browse files Browse the repository at this point in the history
Co-authored-by: CAIMEOX <CAIMEOX@users.noreply.github.com>
  • Loading branch information
Lampese and CAIMEOX authored Sep 16, 2023
1 parent 6470b09 commit 04d407b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 128 deletions.
65 changes: 2 additions & 63 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,68 +29,7 @@ View this document in [简体中文](README_zh-CN.md) | English

### Getting Started

Make sure you have Node.js Stable version or newer.

```bash
npm i @pureeval/serein gulp-cli -g

serein # get help
```

#### Tips
Due to potential performance issues with the `npm` package manager while the installation of some dependencies (such as long-time installation), Serein will prioritize using the `pnpm` package manager if it was installed in your environment.

You can also install the `pnpm` tool using the following method, which is a superior package manager compared to `npm`!

```bash
npm i pnpm -g

pnpm --version
```

### Create A Template Project

Use `serein i` or `serein init` in an empty directory to create a template project interactively.

Use `-y` or `--yes` flag to create the project without asking any questions.

> Notice: On the Android platform, `npm` may not work properly, so ignore the errors it throws.
### Building Project

Use `serein b` or `serein build` to build the current project.

Executing build in the project directory will automatically build the Minecraft Resource Package structure in the `build` directory (but not package it to `.mcpack`).

### Packaging Project

Use `serein p` or `serein pack` to build and package the current project.

Executing pack in the project directory will automatically build the Minecraft Resource Package structure in the `build` directory and package it to `.mcpack`.

### Deploying Project

Use `serein d` or `serein deploy` to deploy the current project to the Minecraft: Bedrock Edition resource directory.

- On Windows platforms, the Minecraft Bedrock Edition directory is automatically found and the current project is deployed.

- On Linux platforms, automatic deployment using the `mcpelauncher` launcher is supported, if you use another launcher, use another platform deployment solution instead.

- On other platforms, please change the `mc_dir` in `.serein.json` to your Minecraft: Bedrock Edition directory.

### Hot Reload

Use `serein w` or `serein watch` to deploy a project and enable hot reloading for it.

Serein will watch the `behavior_packs` and `resource_packs` directories and if any of the files in them change, the project will be rebuilt and automatically deployed to Minecraft: Bedrock Edition.

### Change of Dependency Version

The current Script API iterates very quickly and out-of-date versions of developer resources and games can be disruptive as a result.

Use `serein s` or `serein switch` to change the project manifest dependencies and npm module versions interactively.

Use the `-y` or `--yes` flag to update all dependencies directly to the latest version.
Go to [Serein Document](https://sereinmc.github.io/Docs/) for details.

### Contributing to Serein

Expand All @@ -102,6 +41,6 @@ If you wish to contribute to the project, we welcome Pull Requests, even if it m

### Special Thanks

- Thanks to [@Silvigarabis](https://github.com/Silvigarabis), [@MeowShe](https://github.com/MeowShe), [@xboyminemc](https://github.com/xboyminemc), [@HappyTigerV](https://github.com/HappyTigerV) for his contribution to the testing of this project.
- Thanks to [@Silvigarabis](https://github.com/Silvigarabis), [@MeowShe](https://github.com/MeowShe), [@xboyminemc](https://github.com/xboyminemc), [@HappyTigerV](https://github.com/HappyTigerV) for his contribution to the testing of this project. S
- Thanks to [@MeowShe](https://github.com/MeowShe) for providing the CDN service.
- Thanks to cowsay for contributing a cow to this project.
66 changes: 1 addition & 65 deletions README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
<a href="https://www.npmjs.com/package/@pureeval/serein"><img src="https://img.shields.io/npm/dw/%40pureeval%2Fserein" alt="download"></a>
<a href="https://www.npmjs.com/package/@pureeval/serein"><img src="https://img.shields.io/badge/minecraft_support-latest-8A2BE2" alt="minecraft"></a>
</p>

Serein 是一个为 [Minecraft: Bedrock Edition Script API](https://learn.microsoft.com/zh-CN/minecraft/creator/scriptapi/) 开发的脚手架项目,帮助开发者高效、优雅地创建和管理项目。

查看此文档的 [English](README.md) | 简体中文 版本
Expand All @@ -28,70 +27,7 @@ Serein 是一个为 [Minecraft: Bedrock Edition Script API](https://learn.micros

### 快速开始

请确保您有 Nodejs Stable 及以上的版本。

```bash
npm i @pureeval/serein gulp-cli -g

serein # get help
```

#### 小提示
由于 `npm` 包管理工具可能在安装某些依赖时表现不佳(比如用时过长等),如果您的环境中有 `pnpm` 包管理工具,则 Serein 将会优先采用它。

你也可以使用以下方法安装 `pnpm` 工具,它是一个比 `npm` 更优秀的包管理器!

```bash
npm i pnpm -g

pnpm --version
```

#### 创建项目

Serein 提供了语义相同的长参数 `init` 与短参数 `i` 以创建项目,在您的项目文件夹中执行该命令即可开启引导。接下来通过回答引导的问题,工具就可以帮你构建一个量身定做的模板项目。

添加 `-y/--yes` 参数可以跳过引导直接采用默认配置初始化项目。

> 请注意:如果您是 android 平台的用户,当最后一步安装模块时出现 `symlink` 相关的错误,请忽略它,其不会对 Serein 的使用造成影响。
#### 构建项目

Serein 提供了语义相同的长参数 `build` 与短参数 `b` 构建项目。

在项目根目录执行该命令可以自动创建模板资源包(不打包)并放在 `build` 目录下。

#### 打包项目

Serein 提供了语义相同的长参数 `pack` 与短参数 `p` 以构建和打包项目。

在项目根目录执行该命令可以自动创建模板资源包并且打包为 `.mcpack` 并输出在 `build` 目录下。

#### 部署项目

Serein 提供了语义相同的长参数 `deploy` 与短参数 `d` 以构建和部署项目。

- 对于 Windows 平台,在项目根目录执行该命令可以自动创建资源包并且直接部署至游戏目录。

- 对于 Linux 平台,我们支持对使用 `mcpelauncher` 启动的游戏的自动部署,如果您使用其他启动器或者有其他游戏目录,请看其他平台的配置方案。

- 对于其他平台,您可以在项目初始化后修改 `.serein.json` 中的 `mc_dir` 为您的游戏目录。

#### 热重载

Serein 提供了语义相同的长参数 `watch` 与短参数 `w` 以实时热重载项目到游戏中。

在项目根目录执行该命令后,Serein 将会监视 `behavior_packs``resource_packs` 两个目录,一旦其中的文件发生改变,就会重新构建项目并部署到游戏。

#### 更改依赖版本

目前的 Script API 迭代速度非常快,而且文档紧跟版本更新,过时版本的开发者资源和游戏可能会因此出现破坏性问题。

Serein 提供了长参数 `switch``s` 以更改您项目中的 manifest 依赖与 npm 依赖版本。

在根目录执行该命令可以开启版本切换引导,您可以通过引导重新指定依赖版本并安装依赖项。

添加 `-y/--yes` 参数可以直接更新到最新的依赖(我们不推荐在有 `@minecraft/server` 之外的依赖时使用)。
请前往[Serein 文档](https://sereinmc.github.io/Docs/)查看详情

### 贡献

Expand Down

0 comments on commit 04d407b

Please sign in to comment.