NESLib 使用教程

1. 项目目录结构及介绍

NESLib 是一个用于编写 NES（红白机）游戏的汇编库。以下是项目的目录结构及各部分的简要介绍：

neslib/
├── .gitignore           # Git 忽略文件
├── COPYING             # 许可证文件
├── Makefile            # 制作文件，用于构建项目
├── README.asciidoc     # 项目说明文档
├── crt0.s              # 程序的启动文件
├── display.sinc        # 显示相关的函数和宏
├── famitone2.sinc      # 音乐播放器相关代码
├── lz4vram.s           # LZ4 压缩和解压 VRAM 数据的代码
├── neslib.h            # NESLib 的头文件，包含了库的接口
├── neslib.sinc         # NESLib 的实现文件

• .gitignore：指定在 Git 仓库中应该被忽略的文件和目录。
• COPYING：项目使用的 Zlib 许可证文本。
• Makefile：构建 NES 游戏的自动化脚本。
• README.asciidoc：项目的详细说明文档。
• crt0.s：程序的起始点，负责设置 CPU 寄存器和初始化堆栈等。
• display.sinc：包含与 NES 显示相关的函数和宏。
• famitone2.sinc：FamiTone2 音乐播放器的代码，用于在 NES 游戏中播放音乐。
• lz4vram.s：实现 LZ4 算法压缩和解压 VRAM 数据的代码。
• neslib.h：声明 NESLib 库提供的接口。
• neslib.sinc：NESLib 库的实现，包含了各种有用的 NES 函数。

2. 项目的启动文件介绍

项目的启动文件是 crt0.s。这是 NES 程序的入口点，它执行以下操作：

• 初始化堆栈指针。
• 设置 CPU 的初始状态。
• 调用主函数 main() 开始执行游戏逻辑。

    .global _start

    .section "zp"
    .ds 2   ; 分配 2 字节的零页空间用于堆栈指针

_start:
    sei         ; 禁用中断
    cld         ; 清除_decimal 模式
    ldx   #$ff  ; 将 X 寄存器设置为 $ff
    txs         ; 将 X 寄存器值移至堆栈指针

    ; 此处调用主函数，开始游戏逻辑
    jsr main

3. 项目的配置文件介绍

项目的配置文件是 Makefile。这个文件用于定义如何构建 NESLib 库以及 NES 游戏。以下是 Makefile 的基本结构：

# 定义编译器和汇编器
CC65 = cc65
AS = ca65

# 定义编译器标志
CFLAGS = -O
ASFLAGS =

# 定义目标文件和源文件
TARGET = game
SOURCES = main.c

# 构建目标
all: $(TARGET)

$(TARGET): $(SOURCES:.c=.o)
    $(CC65) -o $(TARGET) $(SOURCES:.c=.o)

.c.o:
    $(CC65) $(CFLAGS) -c $<

.s.o:
    $(AS) $(ASFLAGS) -o $@ $<

在这个 Makefile 中，我们定义了编译器和汇编器的名称，编译器标志，目标文件名，以及源文件列表。all 目标会调用 $(CC65) 来编译源文件并链接它们生成最终的游戏文件 game。