Nael

[!WARNING]
Nael 尚未被认为是稳定的，并且可能会出现破坏性更改。如果您在 CI 或脚本中使用它，应将其固定到特定版本以避免损坏。这包括 nael_core 包和 nael 二进制文件。

您正在查看 nael 命令行工具的 README。如果您正在寻找 nael_core 库，请访问 此处。

一个受 nvm 启发的 Dalamud 版本管理器，使处理 Dalamud 的不同版本（分支）变得简单。

特性

• 快速安装和更新 从发布分发源。
• 即时切换 之间多个本地安装的分支。
• 更新检查 从远程源，只在过时时才运行更新。
• 符合 所有主要操作系统存储标准。
• 无需配置 文件，一切都是基于文件系统的。
• 安全实现 使用一个项目无关的包。
• 跨平台 并且能够在大多数主要操作系统上运行。

查看 示例 部分以查看一些用法示例。

安装

[!IMPORTANT]
WINDOWS 用户 将必须启用 开发者模式，以便在没有管理员权限的情况下使用 Nael，因为 Windows 会阻止在没有启用的情况下创建符号链接。

Cargo（最佳平台支持；推荐）

安装的最佳方式是使用 Cargo 从 crates.io 获取它并为您自己的机器编译。对于某些架构（例如 aarch64），这目前是安装 Nael 的唯一方式。

一旦您已经 在本地设置 Cargo，只需运行以下命令即可下载并编译到您的系统

cargo install nael

预构建的二进制文件

预构建的二进制文件适用于所有 cargo-dist 支持的目标，并使用最新的 Rust 版本构建。要为您的系统下载一个，请访问 GitHub 发布页面，下载适合您的架构和操作系统的正确发布资产，并将其放置在系统中的某个位置 $PATH。

其他包管理器

目前 Nael 无法从任何包管理器获取。

使用 Nael 设置 DALAMUD_HOME

[!注意]
此处需要测试。欢迎提交 PR 以改进本节！

DALAMUD_HOME 是一个社区接受的用于设置自定义 Dalamud 路径的环境变量。

设置环境变量取决于您使用的 shell。对于大多数 POSIX 兼容的 shell，您应该只需将以下内容添加到您的 shell 配置中

export DALAMUD_HOME=$(nael symlink-path)

如果您无法这样做，或者不想这样做，在设置环境变量时调用 Nael 获取路径，可以运行 nael symlink-path 并将命令输出放置在您的环境配置中。此命令返回的符号链接始终指向已设置的激活版本（注意：如果没有设置激活版本，此符号链接将不存在或导致死路径）。

与 MSBuild 集成

将以下内容添加到您的 .csproj 或 .targets 文件中，替换任何现有的 DalamudLibPath 属性定义。

<PropertyGroup>
  <DalamudLibPath Condition="$([MSBuild]::IsOSPlatform('Windows'))">$(appdata)\XIVLauncher\addon\Hooks\dev\</DalamudLibPath>
  <DalamudLibPath Condition="$([MSBuild]::IsOSPlatform('Linux'))">$(HOME)/.xlcore/dalamud/Hooks/dev/</DalamudLibPath>
  <DalamudLibPath Condition="$([MSBuild]::IsOSPlatform('OSX'))">$(HOME)/Library/Application Support/XIV on Mac/dalamud/Hooks/dev/</DalamudLibPath>
  <DalamudLibPath Condition="$(DALAMUD_HOME) != ''">$(DALAMUD_HOME)/</DalamudLibPath>
</PropertyGroup>

现在您可以使用 DALAMUD_HOME 环境变量来覆盖默认的 DalamudLibPath 并使用 Nael 管理您的 Dalamud 版本 - 如果未设置 DALAMUD_HOME，则将使用特定平台的路径。

示例

显示所有命令行选项

> nael help
A Dalamud version manager that makes working with different releases of Dalamud simple.

Usage: nael <COMMAND>

Commands:
  install       Install a Dalamud release from the specified branch
  update        Update a local branch to the latest version
  remove        Remove a branch from this system
  list          List all installed branches
  use           Switch the currently active branch
  active        Get information about the active branch
  symlink-path  Get the path to the symlink that always points to the active branch
  info          Show information about the specified branch
  help          Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

从 release 分支安装 Dalamud 发布版

> nael install release
Successfully installed branch 'release' with version '9.0.0.17'.

更新 release 分支

> nael update release
Branch is already up to date.

将激活分支设置为 release

> nael use release
Successfully set branch 'release' as active.

列出所有已安装的分支

> nael list
Installed branches:
 - stg
 - v9
 * release

获取有关激活版本的信息

> nael active
release
> nael active --format path
/home/example/.local/share/nael/dalamud-branches/release

获取有关 release 分支的本地信息
可选地，使用 --remote 标志查看远程信息。

> nael info release
Local version information for branch release:
- Version: 9.0.0.17
- Git Sha: unknown
- Revision: unknown
- Key: N/A
- Supported GameVer: 2023.03.24.0000.0000
- Runtime version: 7.0.0
- Runtime required: true

许可证

本项目同时受 MIT 许可证和 Apache 许可证（版本 2.0）的约束。有关更多详细信息，请参阅 LICENSE-MIT 和 LICENSE-APACHE。