PocketPy 开源项目教程

1. 项目介绍

PocketPy（简称 pkpy）是一个轻量级的 Python 3.x 解释器，专为游戏脚本设计，使用现代 C 语言编写。它的目标是为游戏脚本提供一个优雅的语法、强大的功能和竞争性能的替代方案，特别是作为 Lua 的替代品。PocketPy 非常容易嵌入到项目中，只需包含一个头文件 pocketpy.h，无需外部依赖。

2. 项目快速启动

2.1 使用单头文件

1. 下载 pocketpy.h 文件。
2. 在你的项目中包含该头文件：

#include "pocketpy.h"

3. 编译时确保设置以下编译标志：
   • --std=c11
   • 对于 MSVC，设置 /utf-8
   • 定义 NDEBUG 宏以优化性能

2.2 使用 CMake

1. 将 PocketPy 仓库克隆到你的项目中作为子模块。
2. 在你的 CMakeLists.txt 中添加以下内容：

add_subdirectory(pocketpy)
target_link_libraries(<your_target> pocketpy)

2.3 示例代码

以下是一个简单的示例，展示了如何在 C 项目中嵌入 PocketPy 并执行 Python 代码：

#include "pocketpy.h"
#include <stdio.h>

int main() {
    // 初始化 PocketPy
    py_initialize();

    // 执行 Python 代码
    bool ok = py_exec("print('Hello, PocketPy!')", "<string>", EXEC_MODE, NULL);
    if (!ok) {
        py_printexc();
        py_finalize();
        return 1;
    }

    // 创建一个列表
    py_Ref r0 = py_getreg(0);
    py_newlistn(r0, 3);
    py_newint(py_list_getitem(r0, 0), 1);
    py_newint(py_list_getitem(r0, 1), 2);
    py_newint(py_list_getitem(r0, 2), 3);

    // 计算列表的和
    py_Ref f_sum = py_getbuiltin(py_name("sum"));
    py_push(f_sum);
    py_pushnil();
    py_push(r0);
    ok = py_vectorcall(1, 0);
    if (!ok) {
        py_printexc();
        py_finalize();
        return 1;
    }
    printf("Sum of the list: %d\n", (int)py_toint(py_retval()));

    // 清理
    py_finalize();
    return 0;
}

3. 应用案例和最佳实践

3.1 游戏脚本

PocketPy 特别适合用于游戏脚本，因为它轻量且易于嵌入。例如，TIC-80 是一个使用 PocketPy 作为脚本语言的幻想计算机，用于制作和分享小型游戏。

3.2 嵌入式系统

由于其轻量级和高效性，PocketPy 也适用于嵌入式系统。例如，MiniPythonIDE 是一个基于 PocketPy 的 Python IDE，适用于资源受限的环境。

3.3 跨平台开发

PocketPy 支持多种平台，包括 Windows、Linux、macOS、Android、iOS 和 Raspberry Pi OS，使其成为跨平台开发的理想选择。

4. 典型生态项目

4.1 TIC-80

TIC-80 是一个使用 PocketPy 作为脚本语言的幻想计算机，用于制作和分享小型游戏。

4.2 MiniPythonIDE

MiniPythonIDE 是一个基于 PocketPy 的 Python IDE，适用于资源受限的环境。

4.3 crescent

crescent 是一个跨平台的 2D 格斗和清版游戏引擎，使用 PocketPy 作为脚本语言。

通过这些应用案例和生态项目，PocketPy 展示了其在不同领域的广泛适用性和强大功能。