File tree Expand file tree Collapse file tree 2 files changed +42
-8
lines changed
docs/zh/quickstart/01project Expand file tree Collapse file tree 2 files changed +42
-8
lines changed Original file line number Diff line number Diff line change 2
2
lastUpdated : true
3
3
---
4
4
5
- # 创建工程
5
+ # 开始使用
6
+
7
+ MCFPP目前提供了两种使用方法:直接使用命令行,或者借助Gradle进行构建。如果只是使用简单的功能,推荐使用命令行。Gradle则提供了更多的功能支持,例如MNI。
8
+
9
+ ## 使用命令行编译
10
+
11
+ 你可以从Github的发布页下载到最新的MCFPP编译器版本,它应当是一个Jar文件。MCFPP的运行需要Java 21或更高版本。你可以将它放在任何地方,只要你能在命令行中找到它。
12
+
13
+ 首先,你需要创建一个项目文件夹,同时创建一个工程配置文件。在下一节中,你可以找到有关工程配置文件的详细格式。在本例中,我们创建了一个` example.json ` 作为工程配置文件。
14
+
15
+ ``` json
16
+ {
17
+ "description" : " " ,
18
+ "namespace" : " mcfpp" ,
19
+ "targetPath" : " D:\\ .minecraft\\ saves\\ MCFPP Example\\ datapacks"
20
+ }
21
+ ```
22
+
23
+ 随后,我们创建一个简单的mcfpp文件,例如` example.mcfpp ` :
24
+
25
+ ``` mcfpp
26
+ func hello(){
27
+ print("Hello World");
28
+ }
29
+ ```
30
+
31
+ 接下来,我们可以使用命令行编译这个项目:
32
+
33
+ ``` shell
34
+ java -jar mcfpp.jar example.json
35
+ ```
36
+
37
+ 这个命令会将` example.mcfpp ` 编译为一个数据包,并输出到` D:\.minecraft\saves\MCFPP Example\datapacks ` 目录下。随后,你可以进入游戏加载这个数据包,并运行` function mcfpp:hello ` 来查看效果。
38
+
39
+ ## 使用Gradle构建
6
40
7
41
TODO
Original file line number Diff line number Diff line change @@ -8,23 +8,23 @@ MCFPP的工程配置文件是一个json文件,一般存放在这个工程的
8
8
9
9
``` json
10
10
{
11
- //项目文件的路径列表。使用通配符选择所有文件
12
- "files" : [
13
- " src/main/mcfpp/**"
14
- ],
11
+ //编译的目标Minecraft版本。仅支持正式版版本号
12
+ "version" : " 1.21.4" ,
15
13
//项目的源代码目录。文件的命名空间根据文件相对于源代码目录的相对路径决定
16
- "sourcePath" : " src/main/mcfpp" ,
14
+ "sourcePath" : " src/main/mcfpp/** " ,
17
15
//数据包的描述。是一个原始JSON文本
18
16
"description" : " " ,
19
17
//数据包的默认命名空间,将会决定数据包中storage等数据的命名空间
20
- "namespace " : " test" ,
18
+ "rootNamespace " : " test" ,
21
19
//数据包的输出路径。数据包、库文件将会输出在此目录下
22
20
"targetPath" : " src/main/resources/lib" ,
23
21
//是否 *不* 生成数据包。默认为false
24
22
"noDatapack" : false ,
25
23
//是否 *忽略* 标准库。默认为false。如果为true,将不会引用mcfpp的标准库。
26
24
"ignoreStdLib" : false ,
27
25
//是否是库。默认为false。库不需要拥有一个入口函数
28
- "isLib" : false
26
+ "isLib" : false ,
27
+ //生成注释的级别
28
+ "commentLevel" : " debug"
29
29
}
30
30
```
You can’t perform that action at this time.
0 commit comments