create-roblox-project

此工具通过生成所需的各种配置文件来创建新项目的初始结构。

单条命令即可设置配置为使用

• Rojo
• Selene
• TestEZ
• Foreman
• Remodel
• run-in-roblox

安装

该项目可以使用 cargo 进行安装

cargo install create-roblox-project

用法

create-roblox-project 有一个帮助命令，可以帮助您了解其他命令的用法。

获取通用帮助和可用命令列表

create-roblox-project help

获取关于某个命令的特定帮助

create-roblox-project help <enter command name>
# example with the 'create' command:
create-roblox-project help create

每个命令都有一个帮助参数

create-roblox-project <enter command name> --help
# example with the 'create' command:
create-roblox-project create --help

create

此命令是此工具存在的原因。首先，选择您想要创建的项目名称。比如说我们选择 CoolStuff。运行以下命令并看看会发生什么

create-roblox-project create CoolStuff

已创建一个名为 cool-stuff 的新目录，让我们用Visual Studio Code打开它来看看 create-roblox-project 生成了什么

code CoolStuff # open VSCode from the command line

您可以看到，已生成了一个带有README、多个配置文件、辅助脚本和 src 目录的git仓库。

目前，create-roblox-project 只支持生成库模板。在未来，它可以很容易地扩展以支持新的项目类型，如插件或地点。

包含的功能

您计划开源您的项目并想添加MIT许可证？您可以通过自定义创建命令来自动添加一个

create-roblox-project create CoolStuff --include mit-license

排除功能

您没有使用 Remodel？您可以通过排除该功能来简单地禁用它

create-roblox-project create CoolStuff --exclude remodel

尚未准备好使用 Foreman？您也可以禁用它

create-roblox-project create CoolStuff -e remodel -e foreman

要查看可用功能的列表以及它们是否默认包含，可以使用 list 命令

create-roblox-project list --features

list

这是一个小型实用命令，用于打印在生成新项目时可以包含的不同功能。运行以下命令以获取所需的所有信息

create-roblox-project list

贡献

查看贡献指南以了解您如何帮助使此项目更好。

新接触Rust？此项目相当简单，因此可以是一个很好的机会入门并编写一些代码。

许可证

create-roblox-project 在MIT许可证的条款下提供。有关详细信息，请参阅LICENSE.txt。