dof-dss/unity_shell

管理 DoF-DSS Unity 项目的 Shell。

v1.0.2 2022-08-17 11:36 UTC

README

Unity Shell 是一个命令行工具,用于管理 Unity2 项目和网站。

要求

  • 计算机
  • PHP 8+ CLI
  • Composer 2.1+

PHP

要查看已安装的 PHP 版本,请在 Mac shell 中运行

php --version

如果您没有安装 PHP 或使用的是旧版本,我建议使用 Brew (https://brew.sh.cn)
安装 Brew 后运行

brew install php

Composer

要查看已安装的 Composer 版本,请在 Mac shell 中运行

composer --version

如果您没有安装 Composer,请使用 brew run

brew install composer

如果您已安装 Composer,请运行

composer self-update

安装

首先在本地上克隆此仓库(有关推荐的 Unity2 目录结构,请参阅 Unity2 Confluence 文档)。

git clone https://github.com/dof-dss/unity_shell.git

从 unity_shell 仓库运行

composer install

为了允许在任何 Unity2 分支上使用 Unity Shell 命令而不直接引用 Unity Shell 可执行文件,我建议将仓库二进制目录添加到您的 shell $PATH 中。
例如,我使用的是 zsh,它是 MacOS 的默认 shell

编辑用户目录下的 .zshrc 并添加以下行(将第一部分替换为仓库的路径)

# Unity Shell
export PATH="/<YOUR PATH TO UNITY SHELL>/bin:$PATH"

保存后,您需要运行

source ~/.zshrc

使用方法

如果您已将 Unity Shell 添加到 shell 路径,您可以直接进入本地 Unity2 服务器分支并运行

unitysh 

这将提供一个命令列表,其中大多数可以忽略,有趣的部分在下一节中列出。

命令

project:create -- 创建新的 Unity 服务器项目。
project:build -- 构建当前项目。

site:add -- 向项目添加新网站。
site:remove -- 从项目中删除网站。
site:edit -- 编辑现有网站的详细信息。
site:list -- 列出项目的网站。