Skip to content

Commit e26bceb

Browse files
稍微改了一下?
1 parent 0267578 commit e26bceb

File tree

3 files changed

+53
-37
lines changed

3 files changed

+53
-37
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# NukkitLearn 教程的编写、排版、格式规范
2+
3+
>> 前言:由于本教程编写缺少排版的相关规范,造成了~~包括后期在内的~~部分读者在阅读体验上的不满。为了方便众读者~~以及满足某些人想要坐牢的愿望~~,特此制定本规范,统一说明正确的姿势。
4+
5+
## To be continued
6+
还没有讨论出来,快了 ~~(0%)~~

前言/前言.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# 前言
22

3-
您需要掌握一定的Java基础后,再观看此教程
3+
您需要掌握一定的Java基础后,再阅读本教程
44

5-
本教程提供了一套完整的Nukkit插件开发教程。学习完此教程,您就可以独自实现一个属于自己的插件了。
5+
本教程提供了一套完整的Nukkit插件开发教程。学习本教程后,您就可以独自实现一个属于自己的插件了。
66

77
再次感谢您阅读本教程。
88

前言/如何搭建环境.md

Lines changed: 45 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,50 @@
1-
# 前言-如何搭建环境
1+
# 前言 - 如何搭建环境
2+
3+
本小节目录:
4+
5+
* [一、环境搭建](#一环境搭建)
6+
* [二、调试插件](#二调试插件)
7+
* [三、本地的导入和打包](#三本地的导入和打包)
8+
* [零、IDEA的汉化](#零idea-的汉化)
9+
10+
---
211

312
参与编写者:MagicLu550
413

5-
后期修订:愉悦师柑也
14+
后期修订:愉悦师柑也
615

7-
**本版本可能为非正式版本,但不影响阅读,请您悉知**
8-
#### 建议学习时间:40 分钟
9-
##### 学习要点: 学会使用 IDEA 搭建 Maven 环境和 Nukkit 开发环境,并学习调试 Nukkit 项目
16+
**本版本可能为非正式版本,但不影响阅读,请您悉知。**
1017

11-
### 一、环境搭建
18+
#### 本小节建议学习时间:40 分钟;
19+
##### 学习要点: 学会使用IDEA搭建Maven环境和Nukkit开发环境,并学习调试Nukkit项目;
1220

13-
搭建环境是我们学习 Nukkit 的第一步,虽然其中下载 IDE 不是必要的一步,但着是我们以便捷的方式进行开发的第一步。
21+
---
22+
### 一、环境搭建
1423

24+
搭建环境是我们学习Nukkit的第一步。虽然安装IDE不是必要的一步,但这是我们能以便捷的方式进行开发的第一步。
1525

16-
1. 首先上 [IDEA官网](https://www.jetbrains.com/idea/download/) 下载我们所需要的版本,我们一般选择免费的 Community 版本,因为它已经符合我们的需求了。作者这里使用的是 Ultimate 版本
26+
1. 首先上 [IDEA官网](https://www.jetbrains.com/idea/download/) 下载我们所需要的版本,我们一般选择免费的Community版本,因为它已经符合我们的需求了。作者这里使用的是Ultimate版本
1727
![1-01](../images/1-01.png)
1828

19-
1. 打开 IDEA 后,我们这里使用 [Maven](https://maven.apache.org/) 项目进行构建。这里使用 [jdk1.8](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) ,只要是图中这样的就可以了。
29+
1. 打开IDEA后,我们这里使用 [Maven](https://maven.apache.org/) 项目进行构建。这里使用 [JDK1.8](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) ,只要是图中这样的就可以了。
2030
![1-02](../images/1-02.png)
2131

22-
3.输入 groupId 和 artifactId (这些是需要你来写的,支持自定义),并且创建项目后,我们会进入到下图的界面。图中的 artifactId 为 MyFirstPlugin.
32+
3.输入 *groupId**artifactId* (这些是需要你来写的,支持自定义),并且创建项目后,我们会进入到下图的界面。图中的 *artifactId***MyFirstPlugin**.
2333
![1-03](../images/1-03.png)
2434

2535
```
2636
关于groupId为何物,Snake1999做出了非常详细的解释(转):
2737
这里有必要做一些详细说明。
28-
GroupId 经常也是 Java 项目的包名。Java 项目的包命名规则有这样的约定
38+
GroupId 经常也是Java项目的包名。Java项目的包命名规则有这样的约定
2939
“以网站倒着写.项目名字” 或者 “网站倒着写.项目名字.模块名字” 为结构。
3040
必须以小写字母开头,
31-
必须与别的 Java 包相区别
32-
Nukkit 内核的所有包都是遵循这个规定的
33-
例如Nukkit 的网站是 nukkit.cn,所以里面包含所有方块 (block) 的包的包名应该是:
41+
必须与别的Java包相区别
42+
Nukkit内核的所有包都是遵循这个规定的
43+
例如Nukkit的网站是nukkit.cn,所以里面包含所有方块(block)的包的包名应该是:
3444
cn.nukkit.block
3545
36-
各位在编写 Nukkit 插件的时候,需要编写一个独特的、和他人的项目不一样的包名,以便与他人开发的插件相区别。
37-
比如译者的网站是 snake1999.com,如果译者编写了一个叫 ExamplePlugin 的 Nukkit 插件,就可以放在包名为 com.snake1999.exampleplugin 的包内。以下包名的结构都是可以使用的:
46+
各位在编写Nukkit插件的时候,需要编写一个独特的、和他人的项目不一样的包名,以便与他人开发的插件相区别。
47+
比如译者的网站是snake1999.com,如果译者编写了一个叫ExamplePlugin的Nukkit插件,就可以放在包名为com.snake1999.exampleplugin的包内。以下包名的结构都是可以使用的:
3848
com.snake1999.exampleplugin
3949
net.mcbbs.tutorialplugin
4050
ru.nukkit.nkexample
@@ -43,7 +53,7 @@ me.fromgate.firstplugin
4353
main.java.plugin
4454
TestPlugin
4555
46-
另外,开发 Nukkit 插件,我们规定不能把插件的任何部分存放在 cn.nukkit 包下,否则后果自负。
56+
另外,开发Nukkit插件,我们规定不能把插件的任何部分存放在cn.nukkit包下,否则后果自负。
4757
4858
关于主类的名称,只要能和别人的主类区分开就可以了,但是不推荐使用MainClass之类的名称。
4959
```
@@ -197,11 +207,11 @@ TestPlugin
197207

198208
###### 其实调试插件很简单,这里我们需要以下四个过程:
199209

200-
- 编译, 打包 → 部署 → 运行加载 → 调试
210+
> 编译打包 → 部署 → 运行加载 → 调试
201211
202-
1. 编译打包很简单。我们使用 IDE 可以轻松实现 Maven 打包
212+
1. 编译打包很简单。我们使用IDE可以轻松实现Maven打包
203213

204-
PS: 在打包之前,建议在pom.xml里加上以下代码,可以解决 IDEA 编译器版本无效等一系列问题.
214+
PS: 在打包之前,建议在pom.xml里加上以下代码,可以解决IDEA编译器版本无效等一系列问题。
205215
```xml
206216
<build>
207217
<plugins>
@@ -220,9 +230,9 @@ PS: 在打包之前,建议在pom.xml里加上以下代码,可以解决 IDEA
220230
</plugins>
221231
</build>
222232
```
223-
本项目所采用的jdk版本为jdk8。如果您使用的不是jdk8,则需要**修改一些地方**
233+
本项目所采用的JDK版本为JDK8。如果您使用的不是JDK8,则需要**修改一些地方**
224234

225-
**jdk9**
235+
**JDK9**
226236
```xml
227237
<build>
228238
<plugins>
@@ -242,7 +252,7 @@ PS: 在打包之前,建议在pom.xml里加上以下代码,可以解决 IDEA
242252
</build>
243253
```
244254

245-
**jdk10**
255+
**JDK10**
246256
```xml
247257
<build>
248258
<plugins>
@@ -263,7 +273,7 @@ PS: 在打包之前,建议在pom.xml里加上以下代码,可以解决 IDEA
263273
```
264274
以此类推....如果行不通,可以尝试可以删掉前面的“1.”
265275

266-
比如,jdk11就是
276+
比如,JDK11就是
267277

268278
```
269279
<source>11</source>
@@ -273,7 +283,7 @@ PS: 在打包之前,建议在pom.xml里加上以下代码,可以解决 IDEA
273283
如图所示,添加这些标签:
274284
![1-08](../images/1-08.png)
275285

276-
如图中按钮所示(请不要在意其中的项目)
286+
如图中按钮所示:
277287
![1-06](../images/1-06.png)
278288

279289
之后我们找到其中的package,点击即可。
@@ -282,10 +292,10 @@ PS: 在打包之前,建议在pom.xml里加上以下代码,可以解决 IDEA
282292
如图所示,出现 **"BUILD SUCCESS"** ,编译就大功告成了。
283293
![1-09](../images/1-09.png)
284294

285-
一般来讲,**目标jar包** 会产生在 target 文件夹中。
295+
一般来讲,**目标jar包**会产生在 target 文件夹中。
286296
![1-10](../images/1-10.png)
287297

288-
2. 部署
298+
1. 部署
289299

290300
之后把打包好的合法插件丢入plugins文件里就完美运行了,这里将不做图示
291301
这就是插件部署的过程。
@@ -298,11 +308,11 @@ PS: 在打包之前,建议在pom.xml里加上以下代码,可以解决 IDEA
298308

299309
### 三、本地的导入和打包
300310

301-
鉴于很多人的需要(因为 NukkitX 的 Maven 服务器太卡了),这里我写一下本地导入jar包的方法。
311+
鉴于很多人的需要(因为NukkitX的Maven服务器太卡了),这里我写一下本地导入jar包的方法。
302312

303313
1. 导入包
304314

305-
其实要简单很多,您需要上 [NukkitX](https://ci.nukkitx.com/job/NukkitX/job/Nukkit/job/master/) 的 Jenkins 下载一个 Nukkit 的jar包,
315+
其实要简单很多,您需要上 [NukkitX的Jenkins](https://ci.nukkitx.com/job/NukkitX/job/Nukkit/job/master/) 下载一个 Nukkit 的jar包,
306316

307317
然后将您的jar包放到您项目根目录的libs文件夹下(这里您需要自己创建)
308318

@@ -314,19 +324,19 @@ PS: 在打包之前,建议在pom.xml里加上以下代码,可以解决 IDEA
314324

315325
![1-12](../images/1-12.png)
316326

317-
选择 Java,这样可以直接导入本地jar包。
327+
选择Java,这样可以直接导入本地jar包。
318328

319329
![1-13](../images/1-13.png)
320330

321-
之后我们选择下载好的 Nukkit 的jar包
331+
之后我们选择下载好的Nukkit的jar包
322332

323333
![1-14](../images/1-14.png)
324334

325335
导入完毕,
326336

327337
![1-15](../images/1-15.png)
328338

329-
2. 构建jar包
339+
1. 构建jar包
330340

331341
再然后,我们在libs下创建一个plugins文件夹(先前的点击下面的OK保存一下),
332342

@@ -404,17 +414,17 @@ PS: 在打包之前,建议在pom.xml里加上以下代码,可以解决 IDEA
404414
![1-38](../images/1-38.png)
405415

406416

407-
### 零、IDEA 的汉化
417+
### 零、IDEA的汉化
408418

409419
~~感谢 Testfor , Itname 等人的帮助,我们找到了 IDEA 的汉化包,[点击这里下载](https://github.com/pingfangx/TranslatorX)~~
410420

411421
上面的汉化包适用于2019.3,
412422

413423
截至2021年10月28日,IDEA Community 已经更新至2021.2.3,
414424

415-
**且官方已支持使用插件进行界面的汉化**
425+
**且官方已支持使用插件进行页面汉化**
416426

417-
*愉悦师柑也* 的 CLion 2021.2.2 为例,您可以前往 Settings - Plugins 搜素 *Chinese* 并安装。
427+
*愉悦师柑也**CLion 2021.2.2* 为例,您可以直接前往 **Settings - Plugins** 搜素 *Chinese* 并安装。
418428

419429
![1-39](../images/1-39.png)
420430

0 commit comments

Comments
 (0)