WalnutAppTemplate 使用教程

WalnutAppTemplate 使用教程

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

WalnutAppTemplate 是一个用于快速创建 Walnut 应用的模板。以下是该项目的目录结构及其介绍：

WalnutAppTemplate/
├── WalnutApp/
│   ├── src/
│   │   └── WalnutApp.cpp
│   └── premake5.lua
├── scripts/
│   └── Setup.bat
├── .gitignore
├── .gitmodules
├── LICENSE.txt
├── README.md
└── premake5.lua

• WalnutApp/: 包含应用程序的主要代码和配置文件。
  • src/: 存放源代码文件。
    • WalnutApp.cpp: 应用程序的主文件，包含启动代码。
  • premake5.lua: 用于生成项目文件的配置文件。
• scripts/: 包含设置脚本。
  • Setup.bat: 用于生成 Visual Studio 2022 解决方案和项目文件的批处理脚本。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• .gitmodules: 配置 Git 子模块。
• LICENSE.txt: 项目的许可证文件。
• README.md: 项目的说明文档。
• premake5.lua: 顶层的 Premake 配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 WalnutApp/src/WalnutApp.cpp。这个文件包含了应用程序的入口点，主要负责初始化和启动 Walnut 应用。以下是该文件的基本结构：

#include <Walnut/Application.h>
#include <Walnut/EntryPoint.h>

class MyApp : public Walnut::Application
{
public:
    virtual void OnUpdate() override
    {
        // 应用程序的更新逻辑
    }
};

Walnut::Application* Walnut::CreateApplication(int argc, char** argv)
{
    MyApp* app = new MyApp();
    app->SetTitle("Walnut App");
    return app;
}

• MyApp 类: 继承自 Walnut::Application，并重写了 OnUpdate 方法，用于处理应用程序的更新逻辑。
• CreateApplication 函数: 创建并返回一个 MyApp 实例，设置应用程序的标题。

3. 项目的配置文件介绍

项目的配置文件主要包括 premake5.lua 文件和 Setup.bat 脚本。

premake5.lua

premake5.lua 文件用于配置项目生成工具 Premake，以便生成适用于不同开发环境的解决方案和项目文件。以下是该文件的基本结构：

workspace "WalnutApp"
    configurations { "Debug", "Release" }
    location "build"

project "WalnutApp"
    kind "ConsoleApp"
    language "C++"
    targetdir "bin/%{cfg.buildcfg}"

    files { "**.h", "**.cpp" }
    includedirs { "Walnut/src" }

    filter "configurations:Debug"
        defines { "DEBUG" }
        symbols "On"

    filter "configurations:Release"
        defines { "NDEBUG" }
        optimize "On"

• workspace: 定义工作区名称和配置。
• project: 定义项目名称和类型。
• files: 指定项目包含的文件。
• includedirs: 指定包含目录。
• filter: 根据配置（Debug 或 Release）设置编译选项。

Setup.bat

Setup.bat 脚本用于生成 Visual Studio 2022 解决方案和项目文件。运行该脚本后，会在 build 目录下生成相应的文件。

@echo off
echo Setting up WalnutApp...
premake5 vs2022
echo Setup complete. Open WalnutApp.sln to get started.

• premake5 vs2022: 调用 Premake 生成 Visual Studio 2022 解决方案和项目文件。
• echo: 输出提示信息。

通过以上配置文件和脚本，可以方便地生成和配置 Walnut 应用程序。