开源软件名称：

开源软件地址：

开源编程语言：

开源软件介绍：

   __________        __  _______
  / ____/ __ \__  __/  |/  / __ \
 / /   / /_/ / / / / /|_/ / / / /
/ /___/ ____/ /_/ / /  / / /_/ /
\____/_/    \__, /_/  /_/\____/
           /____/                                                  

此项目仅用于您运行合法持有的游戏软件副本，持有盗版副本可能会让您面临法律问题。
这是一个使用C实现的pymo引擎的复刻，以方便在各种平台上制作并运行pymo游戏。

如果你需要使用CPyMO制作游戏，可以参见CPyMO + YukimiScript开发模板。

pymo原版参见：https://github.com/pymo/pymo

平台支持列表

第一梯队

CPyMO主要在这些平台上开发，并将主要在这些平台上进行测试和除错。

第二梯队

CPyMO可以编译到这些平台，保证全部功能可用，但不保证用户体验，也没有进行全面的测试。

第三梯队

CPyMO可以编译到这些平台，但可能有部分次要功能不可用。

注：SDL2_mixer音频后端仅支持在BGM通道播放MP3文件，其余通道不支持。
注：SDL 1.2后端不支持对Alpha图像再次设置透明度。
注：SDL_mixer音频后端音频支持格式有限。

与pymo行为差异

• CPyMO的存档位置和存档格式与pymo不同，不能与之互换。
• CPyMO最小音频支持仅包含OGG格式，且CPyMO不会考虑MID格式的音频播放。
• CPyMO的蒙版渐变动画效果与PyMO不同。
• 涉及动画时间曲线的部分CPyMO均做了缓动效果，而pymo则使用线性效果。
• CPyMO的菜单和UI与PyMO不同。
• CPyMO在可以播放视频的情况下比pymo支持更多编码格式的视频。
• CPyMO不支持预载，预载选项会被CPyMO直接忽略。
• CPyMO忽略除字体大小以外所有的字体设置，将自动启用字体阴影和字体反锯齿。

由SDL2支持的桌面平台 (Windows、Linux与macOS)

额外依赖

你需要使用vcpkg包管理器安装以下依赖：

• SDL2
• ffmpeg

如果你使用Microsoft Visual Studio，默认的CMakeSettings.json中指示的依赖版本为x64-windows-static。

如果你需要在macOS上运行，那么你需要首先安装libxcb:

brew install libxcb

视障帮助功能

github action及release上的版本默认会开启视障帮助功能，如果你需要禁用视障帮助功能，可在编译时定义宏NON_VISUALLY_IMPAIRED_HELP.

视障帮助功能将会把游戏中的文本复制到剪切板供读屏软件读取。

全屏

按下Alt + Enter键可在全屏/窗口模式中切换。

在Windows下使用nmake进行构建

首先你需要确保：

• 你已经构建了当前平台的SDL2库，并将二进制目录（含有include和lib文件夹）设置为环境变量%SDL2%（或通过nmake的-a参数传入）。
• 你已经构建了当前平台的FFmpeg库，并将二进制目录（含有include和lib文件夹）设置为环境变量%FFMPEG%（或通过nmake的-a参数传入）。
• 已经安装了某一版本的Windows SDK和MSVC编译器工具链。

关于音频支持，将会按照以下路径进行检查：

• 将会首先检查环境变量FFMPEG是否存在，它需要指向FFMPEG二进制库目录，如果存在则会编译生成依赖于FFMPEG并带有播放视频功能的CPyMO。
• 如果FFMPEG环境变量不存在，则会检查环境变量SDL2_MIXER是否存在，它需要指向SDL2_MIXER的二进制库目录，如果存在则编译生成依赖于SDL2_MIXER的CPyMO。
• 如果两个环境变量均不存在则编译生成不能播放音频和视频文件的CPyMO。

除此之外，你还可以使用以下编译开关：

• 若NO_CONSOLE环境变量存在或通过-a传入并设置为1，则禁用命令行窗口，使得CPyMO仅创建一个游戏窗口。
• 若NON_VISUALLY_IMPAIRED_HELP环境变量存在或通过-a传入并设置为1，则禁用视障帮助功能。
• 若RC_FILE环境变量存在或通过-a传入，则允许传入用户指定的资源文件（主要用于修改图标）。
• 若TARGET环境变量存在或通过-a传入，则允许用户通过TARGET指定输出的可执行文件名称。

之后启动Visual Studio开发人员命令提示符，使用cd命令进入cpymo-backends/sdl2目录，执行nmake -f Makefile.Win32即可构建CPyMO。

使用GNU Make进行构建

1. 你需要安装SDL2，可以选择直接安装libsdl2-dev，或者将SDL2的预编译二进制库存入环境变量SDL2中。
2. 如果你需要使用FFmpeg播放音频和视频，可以选择安装以下库，或者将其预编译的二进制库存入环境变量FFmpeg中：
   • libavformat-dev
   • libavutil-dev
   • libavcodec-dev
   • libswscale-dev
   • libswresample-dev
3. 如果你需要使用SDL2_mixer播放音频，则可以选择安装libsdl2-mixer-dev，或者将SDL2_mixer的预编译二进制库存入环境变量SDL2_mixer中，并定义环境变量export USE_SDL2_MIXER=1.
4. 如果你不想播放音视频，可直接定义export DISABLE_AUDIO=1。
5. 如果你不想使用视障帮助功能，则可以定义export NON_VISUALLY_IMPAIRED_HELP=1。
6. 通过定义TARGET环境变量来指定输出文件名的名称。
7. 执行make -j即可产生可执行文件。

Nintendo 3DS 平台

在Universal Updater应用商店中查看

额外依赖

• devkitPro + 3ds dev
• FFmpeg 5.0

编译3DS用的FFmpeg依赖

在终端或devkitPro的MSYS2控制台（如果你使用Windows的话），cd到cpymo-backends/3ds/目录下，执行./build-3ds-ffmpeg.sh，这将为3DS编译FFmpeg。

产生3dsx与cia文件

于./cpymo-backends/3ds/目录下执行make即可生成3dsx程序。

如果你需要创建cia文件，首先需要确保已经安装了makerom命令，之后在./cpymo-backends/3ds/下执行make cia即可。

你可以在 https://github.com/3DSGuy/Project_CTR 找到makerom的可执行文件。

启动

你需要将你的游戏放置于SD卡的/pymogames/下，保证路径中只有半角英文、数字和下划线，之后该游戏便会被CPyMO for 3DS检测到。
如果你已经安装了Citra且citra命令可用，你可以直接使用make run来调用Citra模拟器来启动CPyMO。

CPyMO for 3DS支持3D显示，可使用3D滑块来打开3D显示功能。
按下START键可以快速退出CPyMO。
按下SELECT键在四种屏幕模式之间切换。 ZL和ZR键功能和A、Y键相同，用于单手操作。

以调试模式启动

如果你需要查看CPyMO控制台，你需要在游戏列表中按住L键，同时按下A键选择游戏，即可激活调试模式。
在这种模式下，下屏会显示CPyMO控制台，Start键将不再可用，对话文本会被强制显示在上屏。

如果无法启动CIA版本的话？

1. 目前仅在New 3DS日版（系统版本号Ver 11.15.0-47J）上对CIA版本进行过测试。
2. 如果你的机器在运行CIA版本的CPyMO时崩溃，请尝试切换到3dsx版。

如何启动3DSX版本？

1. 将cpymo.3dsx放入SD卡的3ds目录下。
2. 启动Homebrew Launcher，建议使用这里的Homebrew Launcher Dummy（https://github.com/PabloMK7/homebrew_launcher_dummy ）。
3. 执行cpymo.3dsx。

在3DS中没有声音？

你需要确保已经Dump了3DS的DSP固件。
如果你没有Dump，那么你需要先安装DSP1（https://github.com/zoogie/DSP1/releases/tag/v1.0 ），并使用它Dump你的3DS的DSP固件。

为3DS适配游戏

如果你需要为3DS适配PyMO游戏，那么建议你使用以下参数：

• 分辨率：400×240
• 音频格式：ogg，16bit signed little-endian，32000Hz
• 背景格式：jpg
• 其他图片：带透明通道的png，不要使用额外的mask灰阶图片
• platform参数：pygame
• 默认字体大小：28
• 视频格式：H264 MP4，低于30FPS，Old 3DS请不要使用视频

关于字体

3DS版本的CPyMO不会加载游戏中自带的字体或者其他TTF字体，而是使用思源黑体。
思源黑体已经被转换为可以被3DS直接识别的bcfnt格式，CPyMO for 3DS中的思源黑体将会按照其原本的SIL协议随CPyMO for 3DS一起分发。

如果自带的字体不能满足你的需求，那么你可以将bcfnt格式的字体放入SD卡中的/pymogames/font.bcfnt路径处，CPyMO将会优先加载这个字体。

Nintendo Switch 平台

额外依赖

• devkitPro + switch dev
• switch-sdl2
• switch-ffmpeg

直接使用devkitPro pacman安装即可。

编译

cd到cpymo-backends/sdl2，执行make -j -f Makefile.Switch即可编译到任天堂Switch平台。
使用make run -j -f Makefile.Switch即可使用yuzu模拟器运行。

启动

将游戏放入SD卡的/pymogames/目录即可。

如果产生乱码，请自行在/pymogames/目录下放置default.ttf。

自定义字体

将字体文件改名为default.ttf放入/pymogames/目录即可加载该字体文件。

默认将会加载Switch自带的字体。

为Switch适配游戏

如果你需要为Switch适配游戏，那么建议你使用以下参数：

• 分辨率：1920×1080
• 音频格式：ogg，32bit signed float little-endian，48000Hz
• 图片格式：带透明通道的png，不要使用mask灰阶图片
• platform参数：pygame
• 视频格式：H264 MP4

Sony Playstation Portable 平台

PSP平台的CPyMO仅能运行s60v3数据包或下述“适配”的包。

额外依赖

• pspdev/pspdev
• psp-sdl2（已经包括到pspdev中）
• psp-sdl2_mixer（已经包括到pspdev中）
• psp-libvorbis（已经包括到pspdev中）
• psp-libogg（已经包括到pspdev中）

编译

cd到cpymo-backends/sdl2，执行make -f Makefile.PSP即可编译到索尼PSP平台。

启动

将EBOOT.PBP、游戏文件夹和default.ttf放在一起。
你需要自己准备可以使用的default.ttf，CPyMO将会加载这个文件作为字体使用。

在使用PPSSPP模拟器的情况下，你需要关闭“系统设置 - 快速内存访问”，并开启“忽略读写错误”。

缺陷

这些缺陷将不会得到修复：

• 由于PSP生态中没有移植的FFmpeg库
  • 视频播放器功能已经禁用
  • 音频播放使用SDL2_mixer后端
    • 音频不支持mp3格式
• 由于PSP机能有限
  • 仅能加载s60v3数据包或下述推荐的PSP数据包
  • 在放入太多游戏时将无法加载游戏列表
  • 加载音效和语音可能会导致内存占用过高，故禁用音效和语音
  • 将不会在启动游戏时加载游戏目录下的system/default.ttf字体
• 由于SDL2 for PSP存在问题
  • 游戏将会在屏幕左上角显示，而不是居中显示
• PPSSPP的“快速内存访问”可能存在问题
  • 目前仅可在PPSSPP在关闭“快速内存访问”时才可以正常启动
• 由于本人不会编写makefile :(
  • Makefile.PSP将会把.o文件弄得到处都是

为PSP适配游戏

如果你需要为PSP适配游戏，那么建议你使用以下参数：

• 分辨率：480×272
• 背景、立绘图像：jpg，立绘图像应当带jpg格式的透明通道mask图
• 系统图像：png，带mask图
• 声音格式：ogg, 16bit signed little-endian, 44100Hz
• platform参数：s60v3
• 不支持的内容：
  • 视频
  • 音效（se）

Sony Playstation Vita 平台

额外依赖

1. 你需要安装vdpm，并使用其安装vitasdk。
2. 通过命令行vdpm sdl2安装SDL2。
3. cd到cpymo-backends/sdl2下执行./build-psv-ffmpeg.sh编译FFmpeg，注意这个版本和vdpm中的ffmpeg使用的剪裁参数不同，不要使用vdpm中的ffmpeg。

编译

在cpymo-backends/sdl2下执行make -f Makefile.PSV即可得到CPyMO.vpk。

安装

安装CPyMO.vpk之后，你还需要在ux0:/pymogames目录下放置default.ttf和游戏文件。

为PSV适配游戏

如果你需要为PSV适配游戏，那么建议你使用以下参数：

• 分辨率：960×544
• 图像：带透明通道的png，不要使用mask灰阶图片
• 声音：ogg，16bit signed，little endian，44100Hz

Emscripten 平台

你可以使用Emscripten将CPyMO编译到Web Assembly或者JavsScript。

在这里你可以找到部署在Github Pages上的Demo。

编译

在cpymo-backends/sdl2下修改Makefile.Emscripten.

变量WASM设置为1时编译到 Web Assembly 二进制文件，为0时编译到 JavaScript。
变量BUILD_GAME_DIR指定要集成的游戏目录，留空则不集成游戏。
以上两个变量可通过环境传入。

默认编译出的结果将不支持视频播放，并且采用SDL2_mixer作为音频后端（只能在BGM通道播放mp3，其他通道不支持mp3），默认采用这种方式是出于编译结果大小的考虑。

• 如果你需要播放MP3格式的语音或音效，或者需要播放视频，那么你需要在编译前执行：
  1. 在cpymo-backends/sdl2目录下执行build-emscripten-ffmpeg.sh。
  2. 执行export AUDIO_BACKEND=ffmpeg启动FFmpeg音视频后端。
• 如果你完全不需要音视频功能，可以执行export AUDIO_BACKEND=none关闭音视频功能以降低编译结果大小。

游戏目录中必须存在/system/default.ttf作为游戏字体使用。

之后使用make -j即可构建。

启动

仅当集成了游戏时，可通过make run -j来使用emrun启动CPyMO。

Android 平台

仅支持 Android 4.3 及以上的系统，如果你需要在更低版本的Android上运行，则可以使用原版PyMO，而不是使用CPyMO。

编译

1. cd到cpymo-backends/android后执行./build-android-ffmpeg.sh以构建FFmpeg。
2. 使用Android Studio打开cpymo-backends/android即可构建APK。

启动

1. 安装CPyMO，并在“设置 - 应用 - CPyMO”中允许其一切权限。
2. 在绝对路径/sdcard/pymogames/或/storage/emulated/0/pymogames/中放置default.ttf和游戏文件夹。
3. 启动CPyMO。

Universal Windows Platform 平台

最低支持Windows 10 (10.0.10240.0)。

编译

前置条件：

• 已经安装vcpkg，并安装以下包：
  • ffmpeg:x86-uwp
  • ffmpeg:x64-uwp
  • ffmpeg:arm-uwp
• 已经安装Visual Studio，并安装以下组件：
  • 使用C++的通用Windows平台开发

使用Visual Studio 2022打开解决方案cpymo-backends/sdl2/uwp/CPyMO.sln即可编译。

启动

你的游戏需要放置在文件夹%LOCALAPPDATA%\Packages\7062935b-c643-4df5-97d1-2744bf120181_*\LocalState中。

其中*的部分可能会不同，找到符合这个模式的目录即可。

之后从开始菜单启动CPyMO。

Nintendo Wii 平台

依赖

• devkitPro + wii dev
• wii-sdl
• wii-sdl_mixer
• ppc-libogg
• ppc-libvorbis
• ppc-libmodplug
• ppc-libmad

直接使用devkitPro pacman安装即可。

编译

cd到cpymo-backends/sdl1，执行make -j -f Makefile.Wii即可生成dol文件。

启动

将游戏和default.ttf放入SD卡的/pymogames/目录即可。

注意，Wii平台仅s60v5数据包才可有较好体验。

如果你使用Dolphin模拟器，则需要将“图形” - “修正” - “纹理缓存”的“精确度”选项设置为“安全”，否则会导致画面刷新卡顿。

使用CPyMO开发新游戏

我们推荐你使用YukimiScript作为开发语言，当然也可以使用传统PyMO游戏的开发方式。

CPyMO-YukimiScript-Template是一套使用YukimiScript语言和Pipe构建系统的CPyMO项目模板，我们建议你基于它来开发游戏。

除此之外，我们建议你使用以下格式：

• 分辨率：CPyMO没有分辨率限制，你可以根据自己的需要选择分辨率
• 音频：ogg，48000Hz，16bit signed
  • 注：CPyMO仅保证wav和ogg两种格式在所有平台上都可识别。
• 视频：mp4
  • 注：CPyMO不保证所有平台都可以播放视频。
• 图片：png

如果你需要生成特定于平台的包，你可以先创建发布包，然后再使用pymo-convert工具将其转换为各个平台上通用的包。

将CPyMO移植到其他平台

CPyMO由一套完全跨平台的通用代码和适配于多平台的“后端”组成。

通用代码放在cpymo文件夹中，后端放在cpymo-backends文件夹中。

其中cpymo-backends/include中的代码规定了每个后端都应当实现的接口。

通用部分

视障帮助

使用宏NON_VISUALLY_IMPAIRED_HELP可以关闭视障帮助功能。

音频系统

使用宏DISABLE_FFMPEG_AUDIO可关闭音频播放器对FFmpeg的依赖，你需要替换成自己的音频系统实现。

使用宏DISABLE_AUDIO可完全关闭音频系统。

视频播放器

使用宏DISABLE_FFMPEG_MOVIE可关闭视频播放器对FFmpeg的依赖，你可以替换为自己的error_t cpymo_movie_play(cpymo_engine * e, cpymo_parser_stream_span videoname)函数进行视频播放。

使用宏DISABLE_MOVIE可完全关闭视频播放功能。

低帧率模式

某些设备可能刷新屏幕会造成闪烁，需要尽可能减少屏幕刷新，这时可定义LOW_FRAME_RATE宏来启用低帧率模式，它将关闭动画效果并显著减少刷新次数。

SDL2后端

SDL2后端在目录cpymo-backends/sdl2中。

解除FFmpeg依赖

某些平台上FFmpeg难以编译，同时定义DISABLE_FFMPEG_AUDIO和DISABLE_FFMPEG_MOVIE即可彻底对解除FFmpeg的依赖，并替换为你的音频视频后端。

如果你只想解除FFmpeg依赖，并且不想提供后端，则可通过同时定义DISABLE_AUDIO和DISABLE_MOVIE来彻底关闭音频和视频播放器支持。

SDL2_mixer音频后端

如果你想解除FFmpeg依赖后依然可以播放音频，可以考虑启动SDL2_mixer音频后端支持。
SDL2_mixer音频