ox_lib 开源项目教程

ox_lib 开源项目教程

ox_libModules to utilise in other resources via imports and exports.项目地址:https://gitcode.com/gh_mirrors/ox/ox_lib

1. 项目的目录结构及介绍

ox_lib 项目的目录结构如下：

ox_lib/
├── client/
│   ├── main.lua
│   ├── utils.lua
│   └── ...
├── server/
│   ├── main.lua
│   ├── database.lua
│   └── ...
├── shared/
│   ├── config.lua
│   ├── enums.lua
│   └── ...
├── fxmanifest.lua
└── README.md

目录介绍

• client/: 包含客户端脚本文件，主要负责游戏内的客户端逻辑。

  • main.lua: 客户端主入口文件。
  • utils.lua: 客户端工具函数文件。

• server/: 包含服务器端脚本文件，主要负责服务器逻辑和数据库交互。

  • main.lua: 服务器主入口文件。
  • database.lua: 数据库操作文件。

• shared/: 包含共享脚本文件，客户端和服务器都可以访问。

  • config.lua: 配置文件。
  • enums.lua: 枚举定义文件。

• fxmanifest.lua: 项目清单文件，定义了资源依赖和加载顺序。

• README.md: 项目说明文档。

2. 项目的启动文件介绍

客户端启动文件

client/main.lua 是客户端的主入口文件，负责初始化客户端逻辑和加载其他客户端脚本。

-- client/main.lua
Citizen.CreateThread(function()
    -- 初始化客户端逻辑
    print("客户端已启动")
    -- 加载其他客户端脚本
    require("utils")
end)

服务器启动文件

server/main.lua 是服务器的主入口文件，负责初始化服务器逻辑和加载其他服务器脚本。

-- server/main.lua
AddEventHandler('onServerResourceStart', function(resourceName)
    if GetCurrentResourceName() == resourceName then
        -- 初始化服务器逻辑
        print("服务器已启动")
        -- 加载其他服务器脚本
        require("database")
    end
end)

3. 项目的配置文件介绍

shared/config.lua 是项目的配置文件，包含了项目的各种配置选项。

-- shared/config.lua
return {
    DB_HOST = "127.0.0.1",
    DB_USER = "root",
    DB_PASSWORD = "",
    DB_NAME = "ox_lib",
    DEBUG_MODE = true,
}

配置项介绍

• DB_HOST: 数据库主机地址。
• DB_USER: 数据库用户名。
• DB_PASSWORD: 数据库密码。
• DB_NAME: 数据库名称。
• DEBUG_MODE: 调试模式开关。

通过修改 config.lua 文件中的配置项，可以调整项目的运行参数和行为。

ox_libModules to utilise in other resources via imports and exports.项目地址:https://gitcode.com/gh_mirrors/ox/ox_lib