Don't Starve Mod Tools 使用教程

1. 项目目录结构及介绍

Don't Starve Mod Tools 是一个用于创建和编译 Don't Starve 游戏模组的工具集。以下是项目的目录结构及各部分功能的简要介绍：

ds_mod_tools/
├── bin/
│   └── win32/  # Windows 平台下编译后的可执行文件存放目录
├── build/
│   ├── osx/    # macOS 平台下编译后的文件存放目录
│   ├── proj/   # 生成项目文件的目录，包含 makefile 或 Visual Studio 项目文件
│   └── win32/  # Windows 平台下编译后的文件存放目录
├── lib/
│   └── tinydir/  # 一个轻量级的目录操作库
├── pkg/
├── src/
│   ├── premake4.bat  # 生成 Windows 平台 Visual Studio 项目文件的批处理脚本
│   ├── premake.sh    # 生成 macOS 和 Linux 平台 makefile 的脚本
│   └── ...           # 其他源代码文件
├── tools/
│   └── ...           # 编译工具和其他相关工具
├── .gitignore        # 指定 Git 忽略的文件和目录
├── LICENSE           # 项目许可证文件
└── README.md         # 项目说明文件

• bin/: 存放编译后的可执行文件和库文件。
• build/: 存放编译过程中生成的中间文件和最终编译结果。
• lib/: 包含项目依赖的库文件。
• pkg/: 存放项目打包文件。
• src/: 包含项目的所有源代码文件。
• tools/: 包含项目所需的编译工具和其他辅助工具。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目使用的许可证。
• README.md: 项目的说明文件。

2. 项目的启动文件介绍

项目的启动文件主要是指用于生成项目构建文件的脚本。以下是两个主要的启动文件：

• src/premake4.bat: 在 Windows 平台上，运行此批处理脚本可以生成 Visual Studio 的项目文件。
• src/premake.sh: 在 macOS 和 Linux 平台上，运行此脚本可以生成 makefile 文件。

例如，在 Windows 平台上，你可以通过以下命令启动项目：

cd src
premake4.bat

这将在 build/proj/ 目录下生成 Visual Studio 的项目文件。

3. 项目的配置文件介绍

Don't Starve Mod Tools 使用 Premake 来生成构建系统，因此主要的配置文件是 Premake 脚本。以下是一些常见的配置步骤：

• src/premake4.lua: Premake 配置脚本，定义项目的构建设置和依赖关系。
• build scripts: 在 src/ 目录下，还有一些用于生成不同平台构建文件的脚本。

例如，以下是 src/premake4.lua 的一个配置片段：

solution "ds_mod_tools"
    configurations { "Debug", "Release" }
    platforms { "x32", "x64" }

    project "ds_mod_tools"
        targetdir "build/bin/$(platform)_$(configuration)"
        kind "ConsoleApp"
        language "C++"

        files { "src/**.cpp", "src/**.h" }
        includedirs { "lib/tinydir" }
        libdirs { "lib" }
        links { "tinydir" }

        configuration "Debug"
            defines { "DEBUG" }
            flags { "Symbols" }

        configuration "Release"
            defines { "NDEBUG" }
            optimize "On"

这段代码定义了项目的配置，包括目标目录、项目类型、语言、源文件、头文件、包含目录、库目录和链接库等。通过修改这个文件，可以调整项目的构建设置以满足不同需求。