安装配置

本指南提供了在 FiveM 服务器中安装 Sleet ORM 的详细说明。

前置要求

安装 Sleet ORM 之前，请确保您已具备：

• 运行中的 FiveM 服务器
• 已安装和配置 oxmysql 资源
• 基本的 FiveM 资源管理知识

第一步：下载 Sleet

将 Sleet ORM 仓库克隆到您的 resources 文件夹：

cd resources/[sleet]
git clone https://github.com/SleetCo/sleet-orm sleet

您的文件夹结构应该如下：

resources/
├── [sleet]/
│   └── sleet/          # Sleet ORM 资源
├── [其他资源]/

第二步：配置 server.cfg

将 Sleet 添加到您的 server.cfg 文件中。确保在 oxmysql 之后启动：

# 数据库
ensure oxmysql

# 使用 Sleet 的资源
ensure your_gamemode
ensure your_scripts

第三步：资源配置

在您资源的 fxmanifest.lua 中，添加必需的依赖项：

fx_version 'cerulean'
game 'gta5'

-- 依赖项
dependency 'oxmysql'
dependency 'sleet'

server_scripts {
    '@oxmysql/lib/MySQL.lua',
    '@sleet/sleet.lua',    -- 必须在您的脚本之前加载
    'server/**/*.lua'
}

第四步：验证安装

创建一个简单的测试来验证 Sleet 是否正常工作：

-- server/test.lua
local sl = Sleet

-- 测试 Sleet 是否已加载
if sl then
    print("✓ Sleet ORM 加载成功！")

    -- 测试数据库连接
    local db = sl.connect()
    if db then
        print("✓ 数据库连接建立成功！")
    else
        print("✗ 数据库连接失败！")
    end
else
    print("✗ 未找到 Sleet ORM！")
end

第五步：CLI 工具（可选）

为了使用高级功能如类型生成，可以安装 CLI 工具：

通过 npm（推荐）

npm install -g sleet-orm-cli

手动安装

从 GitHub Releases 下载适当的二进制文件。

故障排除

常见问题

"Sleet is not defined"

• 确保在 fxmanifest.lua 中的脚本之前加载了 @sleet/sleet.lua

"Database connection failed"

• 验证 oxmysql 已正确配置
• 检查 oxmysql 配置中的数据库凭据

资源无法启动

• 检查服务器控制台的错误消息
• 确保所有依赖项都在 fxmanifest.lua 中列出

获取帮助

如果遇到问题：

• 搜索现有的 GitHub issues
• 加入我们的社区讨论

下一步

现在 Sleet 已安装完成：

• 学习基础用法
• 探索示例
• 查看最佳实践