Skip to content

创建神岛组件库项目

在ArenaPro插件中,创作者不仅可以着手打造独特的地图项目,还能够创建神岛组件库,这一平台专为存放和分享可复用的代码组件而设计。这些组件能够轻松地被其他创作者导入并应用,极大地提升了开发效率与代码复用性。

若你希望深入了解如何安装npm包,请查阅相关指南。

项目文件夹的创建

步骤一:新建空文件夹

首先,你需要在你的文件系统中新建一个空文件夹,作为你的神岛组件库项目的根目录。

创建空文件夹

步骤二:文件夹命名

为确保项目能够顺利编译,请务必使用纯英文为项目文件夹命名,避免使用非法字符、中文及空格。

  • 项目名称:Arena智能输出
  • 英文名:arena-rich

项目命名

打开项目

步骤:在编辑器中导入文件夹

接下来,请打开你的VSCode编辑器,并通过以下路径导入你刚刚创建的文件夹:文件(File) -> 打开文件夹(Open Folder) -> 选择你的项目文件夹。

打开文件夹

导入后,你的项目结构应如下所示:

导入后效果

新建Arena-Ts项目

在VSCode中,你可以通过按下F1Shift+Ctrl+P(Mac用户请按Shift+Cmd+P)调出命令面板。在命令面板中,输入arena-ts,并选择新建Arena-Ts项目(Create new Arena-Ts Project)选项。

新建Arena-Ts项目

随后,脚手架将引导你完成项目的创建过程。

项目创建中

在创建过程中,脚手架会询问一些配置问题,请根据你的个人习惯进行选择。特别地,当被问及项目类型时,请务必选择神岛组件库

选择项目类型

选择完成后,按Enter键确认。脚手架将开始创建文件,并可能询问你关于package.json文件的一些信息。若你无需填写,直接按Enter键跳过即可。

填写package.json信息

接下来,脚手架将安装项目开发及编译所需的依赖包。请耐心等待创建过程完成。

当终端显示如下信息时,表示项目已成功安装:

项目安装成功

若你在安装过程中遇到任何问题,请参考:NodeJS 部署Arena-Ts问题解决方案

此刻,你的神岛组件库项目已成功创建!

Arena-Ts项目创建成功

验证项目

在安装完脚手架之后,你需要验证项目的正常运行。为此,只需点击编辑器左下角的完整构建项目按钮。

若项目构建成功,你将在终端窗口中看到如下提示信息:

构建成功

与神岛地图项目的差异

虽然神岛组件库项目与神岛地图项目在结构上相似,都包含服务端和客户端脚本入口,但为了满足npm包的规范与统一要求,神岛组件库项目中的包不能同时包含客户端和服务端的代码。

package.json文件中,main字段将自动配置为指向服务端或客户端的脚本入口(具体取决于脚手架的选择)。同时,types字段将指向入口文件的类型提示文件,而files字段则只包含服务端或客户端打包后的代码。

此外,dao3.config.json文件中的npmPackage属性将用于指定构建的端,并停止构建另一端以加快速度。

最后,项目还将生成npm包所需的README.md模板。

后期如何更换端

若你需要在后期更换项目的类型(例如从服务端切换到客户端),只需打开package.json文件,并点击右上角的设置按钮进行快速切换。

它会根据配置的dao3.config.json文件来判断入口,并自动进行切换。

更换项目类型