TamaLIB 项目下载及安装教程

1. 项目介绍

TamaLIB 是一个硬件无关的 Tamagotchi P1 模拟库，旨在从微控制器（MCU）到桌面计算机等各种平台上运行。该项目的目标是让虚拟生命在数字世界中传播。TamaLIB 已经成功在多个平台上实现，包括桌面计算机、STM32F072 MCU 基板、Arduino UNO 和 R 软件环境等。

2. 项目下载位置

要下载 TamaLIB 项目，请访问项目的 GitHub 仓库。你可以通过以下命令克隆项目到本地：

git clone https://github.com/jcrona/tamalib.git

3. 项目安装环境配置

3.1 系统要求

TamaLIB 可以在多种平台上运行，但以下是推荐的系统配置：

• 操作系统: Windows 10/11, macOS, Linux
• 编译器: GCC (GNU Compiler Collection)
• 开发环境: Visual Studio Code, CLion, Eclipse

3.2 环境配置示例

以下是使用 Visual Studio Code 配置环境的步骤：

1. 安装 Visual Studio Code:

   • 下载并安装 Visual Studio Code 从 官方网站。

2. 安装 C/C++ 扩展:

   • 打开 Visual Studio Code，点击左侧的扩展图标，搜索 "C/C++" 并安装。

3. 配置编译器:

   • 确保你的系统上已经安装了 GCC 编译器。如果没有，请根据你的操作系统安装 GCC。

4. 打开项目:

   • 在 Visual Studio Code 中打开克隆的 TamaLIB 项目文件夹。

4. 项目安装方式

4.1 导入 TamaLIB

要使用 TamaLIB，你需要将所有相关的 .c 和 .h 文件导入到你的项目中（例如在 lib 子文件夹中）。你还需要使用提供的模板创建一个 hal_types.h 文件，并实现 hal_t 结构，该结构将作为 TamaLIB 和你的操作系统或 SDK 之间的抽象层。

4.2 初始化 TamaLIB

在你的项目中，按照以下步骤初始化 TamaLIB：

/* 注册 HAL */
tamalib_register_hal(&my_hal);

/* 初始化 TamaLIB */
tamalib_init(my_program, my_breakpoints, 1000000); // my_breakpoints 可以是 NULL, 1000000 表示时间戳以微秒为单位

/* 进入 TamaLIB 的主循环 */
tamalib_mainloop();

/* 释放 TamaLIB */
tamalib_release();

4.3 处理按钮输入

你的主项目应将任何按钮输入转发给 TamaLIB 使用 tamalib_set_button() 函数。

5. 项目处理脚本

TamaLIB 提供了一个简单的处理脚本，用于在项目中处理按钮输入和其他事件。以下是一个示例脚本：

#include "tamalib.h"

void handle_button_input(int button) {
    tamalib_set_button(button);
}

int main() {
    // 初始化 TamaLIB
    tamalib_init(my_program, NULL, 1000000);

    // 处理按钮输入
    handle_button_input(BUTTON_A);

    // 进入主循环
    tamalib_mainloop();

    // 释放资源
    tamalib_release();

    return 0;
}

通过以上步骤，你可以在你的项目中成功下载、配置和使用 TamaLIB。