search

Strrationalism / CPyMO

PyMO AVG Game Engine implemention in C.
GNU Affero General Public License v3.0
126 stars 11 forks source link
3ds-homebrew android android-app c cross-platform emscripten galgame linux macos nintendo-3ds nintendo-switch psp psp-homebrew psvita psvita-homebrew switch-homebrew uwp visual-novel-engine wasm windows-desktop

readme 

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

BANNER

LICENSE

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

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

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

常见问题

运行秋之回忆、秋之回忆2、缘之空时弹出“请安装MO2PyMO补丁”的提示应该怎么办

在这里按提示下载安装MO2PyMO补丁。

在3DS上没有声音怎么办

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

如何启动Windows版CPyMO

把cpymo.exe复制到游戏文件夹并双击启动。

在3DS/PSP/Wii上运行游戏时，我需要对游戏的数据包进行转换？

一般情况下，3DS和PSP版本CPyMO可以直接运行s60v5版本，如果你想获得更好的体验或者你在使用Wii，可以下载CPyMO GUITool来创建面向3DS、PSP和Wii的游戏包。

平台支持列表

第一梯队

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

平台 后端 视频播放器 音频支持 字体支持 额外功能
Windows SDL2 FFmpeg FFmpeg, SDL2_mixer 加载系统字体 视障帮助
Nintendo 3DS 3DS FFmpeg FFmpeg 自带字体 游戏选择器
Sony PSP SDL2 无 FFmpeg 外置字体 游戏选择器

第二梯队

CPyMO可以编译到这些平台，但没有进行全面的测试。

平台 后端 视频播放器 音频支持 字体支持 额外功能
Linux SDL2 FFmpeg FFmpeg, SDL2_mixer 外置字体 视障帮助
macOS SDL2 FFmpeg FFmpeg, SDL2_mixer 加载系统字体 视障帮助
iOS SDL2 FFmpeg FFmpeg 外置字体 游戏选择器
Nintendo Switch SDL2 FFmpeg FFmpeg 加载系统字体 游戏选择器
UWP SDL2 FFmpeg FFmpeg 加载系统字体 游戏选择器
Emscripten SDL2 FFmpeg FFmpeg, SDL2_mixer 外置字体
Android SDL2 FFmpeg FFmpeg 外置字体 游戏选择器,视障帮助

第三梯队

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

平台 后端 视频播放器 音频支持 字体支持 额外功能
Sony PS Vita SDL2 不支持 SDL2_mixer 外置字体 游戏选择器
Nintendo Wii SDL 1.2 不支持 SDL_mixer 外置字体 游戏选择器
Windows (SDL 1.2) SDL 1.2 FFmpeg FFmpeg, SDL_mixer 加载系统字体
Linux (SDL 1.2) SDL 1.2 FFmpeg FFmpeg, SDL_mixer 外置字体
POSIX (ASCII ART) ASCII ART 不支持 不支持 外置字体 在控制台上操作并输出画面
POSIX (Text) Text 不支持 不支持 无需 在控制台上操作并输出游戏文本

注：SDL 1.2后端不支持对Alpha图像再次设置透明度。

与pymo行为差异

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

额外依赖

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

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

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

brew install libxcb

全屏

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

在Windows下使用nmake进行构建

首先你需要确保：

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

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

之后启动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. 通过定义TARGET环境变量来指定输出文件名的名称。
  6. 通过定义DEBUG=1环境变量来启动调试信息，之后便可使用gdb进行调试。
  7. 执行make -j即可产生可执行文件。

在Windows下，你也许需要拷贝以下dll文件到可执行文件目录才可以在非MSYS2环境下运行CPyMO并启动调试：

在构建之前，你可以进行一些配置：

Nintendo 3DS 平台

在Universal Updater应用商店中查看

额外依赖

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

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

如果你无法启动cia版本，可以尝试启动3dsx版本。

以调试模式启动

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

如何启动3DSX版本？

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

为3DS适配游戏

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

关于字体

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

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

Nintendo Switch 平台

额外依赖

直接使用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适配游戏，那么建议你使用以下参数：

iOS 平台

安装

可以通过Sideloady等侧载软件在iOS上侧载CPyMO for iOS。

启动

使用iTunes打开CPyMO文档目录，将default.ttf和游戏放入之后点击CPyMO图标即可启动。

Sony Playstation Portable 平台

依赖

  1. pspsdk.
  2. 使用psp-pacman安装:
    • sdl2
    • sdl2-image
  3. 使用./cpymo-backends/sdl2/build-psp-ffmpeg.sh编译FFmpeg

编译

在cpymo-backends/sdl2下执行make -f Makefile.PSP即可生成EBOOT.PBP.

安装

在PSP的内置存储或记忆棒的PSP/GAME目录下创建目录CPYMO，然后将EBOOT.PBP和default.ttf放入，之后将游戏放入该文件夹即可。

建议字体文件default.ttf小于2MB。

所有的游戏数据包必须使用pymo-convert转换为psp目标才可正常运行。

为PSP适配游戏

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

Sony Playstation Vita 平台

PSV版本不支持自动存档，需要手动存档。

额外依赖

  1. 你需要安装vdpm，并使用其安装vitasdk。
  2. 执行以下命令安装依赖：
vdpm sdl2
vdpm sdl2_mixer
vdpm flac
vdpm libmodplug
vdpm mpg123
vdpm libogg
vdpm libvorbis
vdpm libmikmod

编译

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

安装

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

为PSV适配游戏

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

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），默认采用这种方式是出于编译结果大小的考虑。

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

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

启动

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

Android 平台

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

视障帮助

GitHub Action和Release中的“CPyMO for Android (Accessibility)”版本即为带有视障帮助的版本。

视障帮助功能会调用系统TTS进行朗读，并加入了一些手势操作：

编译

  1. cd到cpymo-backends/android后执行./build-android-ffmpeg.sh以构建FFmpeg。
  2. 如果需要启用视障帮助功能，请修改gradle.properties中的ENABLE_TEXT_EXTRACT和ENABLE_TEXT_EXTRACT_ANDROID_ACCESSIBILITY属性为true.
  3. 使用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)。

编译

前置条件：

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

启动

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

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

之后从开始菜单启动CPyMO。

Nintendo Wii 平台

依赖

直接使用devkitPro pacman安装即可。

编译

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

启动

你需要确保你的SD卡没有开启写保护，否则CPyMO将会在启动游戏时崩溃。 将游戏和default.ttf放入SD卡的/pymogames/目录即可。

注意，Wii平台的游戏数据包需要经过pymo-convert转换为wii目标才可正常运行，也可直接使用s60v5数据包。

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

由于Wii平台处理器特殊，所以全局存档中关于CG开启状况、已读对话状况等与Hash Flags相关的数据在移动到其他平台时将会丢失。

为Wii平台适配游戏

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

使用CPyMO开发新游戏

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

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

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

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

将CPyMO移植到其他平台

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

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

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

通用部分

调试

存档系统

音频系统

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

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

视频播放器

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

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

禁用蒙版图转场效果

使用宏DISABLE_MASKTRANS即可将所有的蒙版图转场效果替换为普通的渐入渐出效果。

低帧率模式

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

解除stb依赖

某些平台上不能运行stb库（如Sony PSP），可定义以下宏来分别禁用stb依赖：

限制窗口大小到屏幕大小

如果窗口大小太大超出屏幕范围，可定义宏LIMIT_WINDOW_SIZE_TO_SCREEN使游戏窗口超出屏幕大小时直接创建最大化的游戏窗口。

但是你需要重新实现一些函数来加载图片。

目前只有SDL2具有其他的图片加载实现，参见“SDL2后端 - 替换stb库”。

注意，定义此宏后，album功能将不能产生album UI图像。

解除FFmpeg依赖

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

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

如果在不支持半透明方块填充的平台上

可以定义DISABLE_HIGHLIGHT_SQUARE宏以禁用对选项高亮的半透明方块填充，如CG上的高亮方块。

如果FFmpeg不能识别媒体文件的路径

定义DONT_PASS_PATH_TO_FFMPEG宏即可禁止FFmpeg使用路径来识别媒体文件，而是使用Stream Reader来读取文件，但这样做性能更差。

SDL2后端

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

强制居中

某些平台不能使用SDL自带的居中功能，则可以在定义了SCREEN_WIDTH宏的情况下来启用ENABLE_SCREEN_FORCE_CENTERED宏来强制居中屏幕。

禁用鼠标

某些平台上没有鼠标和触摸屏，使用DISABLE_MOUSE宏即可禁用鼠标。

替换stb库

定义以下宏可以取消对stb_truetype的依赖：

定义以下宏可以使用SDL2库来替代上述stb库的功能：

SDL2_mixer音频后端

如果你想解除FFmpeg依赖后依然可以播放音频，可以考虑启动SDL2_mixer音频后端支持。 SDL2_mixer音频后端可能无法播放mp3格式的语音和音效。

启用SDL2_mixer音频后端之前，必须禁用FFmpeg视频播放器：

之后：

  1. 定义DISABLE_FFMPEG_AUDIO关闭FFmpeg音频依赖
  2. 定义ENABLE_SDL2_MIXER_AUDIO_BACKEND启用SDL2_Mixer音频后端。

如果你的设备上SDL_mixer中Mix_Music不能正常工作，则可以使用DISABLE_SDL2_MIXER_MUSIC宏将其替换为使用Mix_Chunk来播放BGM。

你可以定义以下宏来改变SDL2_Mixer后端的音频参数：

全屏切换

定义宏ENABLE_ALT_ENTER_FULLSCREEN可启用按下Alt+Enter键切换全屏的功能。

游戏选择器

使用宏USE_GAME_SELECTOR可启用游戏选择器。 一旦使用游戏选择器：

加载系统字体

定位到cpymo_backend_font.c中的函数error_t cpymo_backend_font_init(const char *gamedir)，向此函数添加用于加载系统字体的代码。

定义TEXT_LINE_Y_OFFSET即可调整字体行Y坐标偏移量。 定义TEXT_CHARACTER_W_SCALE即可调整字体宽度倍数。

选择帧缓存格式

定义FRAMEBUFFER_PIXELFORMAT为需要使用的SDL2像素格式，即可使用对应的像素格式作为帧缓存格式。

禁用图片组件缩放

有些平台可能不支持图片组件的缩放，定义DISABLE_IMAGE_SCALING宏即可阻止使用图片组件缩放行为。

从文件包中流式加载图片

流式加载图片的性能在不同平台上可能会有不同表现，如果某些设备需要占用更小的内存空间或流式加载图片更快，可定义宏STREAMING_LOAD_IMAGE来流式加载图片。

垂直同步

使用DISABLE_VSYNC宏即可禁用垂直同步并以最高可能的帧率运行。

低质量的rule图过场

定义宏LOW_QUALITY_MASKTRANS即可使用低质量但性能更高的rule图过场动画。

SDL 1.2后端

该后端用于兼容较为老旧的平台，位于cpymo-backends/sdl1中。

SDL 1.2的Alpha混合与缩放功能受限，将不会支持已有透明图层的Alpha变化，同时也禁用了右键菜单的背景缩放功能。

此外，SDL 1.2后端使用了SDL2后端的cpymo_backend_font.c和cpymo_backend_save.c。

桌面版本 (Windows 95/98/Me/2000/XP, Unix)

这里的产生的版本支持较旧的Windows和Unix-like操作系统。

如果你使用Windows，那么你将只能使用msys2和mingw来编译。

你可以使用以下环境变量来修改开关：

之后在cpymo-backends/sdl1中执行make即可编译。

在Windows上，如果你要使用MSYS2进行编译，那么你可能需要以下DLL：

使用宏适配目标系统

Software Backend

这是CPyMO软件渲染器的实现，如果你需要在不依赖外部组件的情况下进行渲染，可以将这里的代码与你的适配代码一起编译。

你只需要创建cpymo_backend_software_context并使用cpymo_backend_software_set_context将它设置为当前渲染上下文即可将RGB24缓冲区渲染到指定的内存区域。

详细例子可参考CPyMO ASCII Art。

CPyMO ASCII ART

这是一个CPyMO变种，没有音频和视频播放器支持，它将会在控制台上输出画面，Just for fun!

它依赖于Software Backend。

编译

如果你需要编译到Windows，那么你应该使用MinGW和MSYS2来构建它。

cd到cpymo-backends/ascii-art，执行make或mingw32-make即可生成可执行文件。

启动

参见“CPyMO 桌面平台”的启动方式。

注意：光敏性癫痫患者请不要使用该版本。 注意：Windows上控制台输出效率较低，帧率可能会很差，建议使用Linux或macOS来执行该程序。

CPyMO ASCII ART仅支持键盘操作：

CPyMO Text

这是一个CPyMO变种，仅在控制台上输出游戏文本，它在cpymo-backends/text内。

关于编译和启动，均与CPyMO ASCII ART相同。

工具

cpymo-tool

该工具用于开发PyMO游戏，与原版PyMO工具完全兼容，它提供以下功能：

启动此程序即可看到详细用法。

构建cpymo-tool

你可以选择以下三种方式之一来构建cpymo-tool：

  1. 直接使用CMake构建整个项目。
  2. 使用GNU Make在cpymo-tool目录中执行make命令。
  3. 使用Microsoft NMake在cpymo-tool目录中执行nmake -f Makefile.Win32命令构建。

pymo2ykm

该工具用于将PyMO脚本语言编译到YukimiScript语言。

libpymo

用于将PyMO API公开到YukimiScript语言中， 使得YukimiScript语言可以访问PyMO/CPyMO引擎的各项功能。

关于“Song of PyMO”

此乐曲在支持启动音乐的平台作为CPyMO的启动音乐使用，为CPyMO软件的一部分。 乐谱文件可使用Muse Score 4打开。

作曲：许兴逸

贡献者

赞助

如果您有兴趣推动本软件的发展，可以对我们进行赞助。

弦语蝶梦独立游戏工作室 开源软件事业

您可以在爱发电对我们进行赞助：

https://afdian.net/order/create?user_id=4ffe65ae104a11ec9bdf52540025c377

本软件主要作者 许兴逸

您可以通过支付宝或微信对本软件主要作者许兴逸进行赞助：

alipay wechat

帮助我们移植到更多平台

如果您有兴趣帮助我们移植到更多平台，您可以考虑向本软件主要作者许兴逸以借用的形式寄送您需要移植CPyMO的设备。 我们将会评估该平台是否适用CPyMO，在移植和测试工作完成后，该设备将会被退还。

我们无意于为私人开发的硬件平台进行移植，您所提供的设备必须是在市场上占有一定份额的平台。

详细信息您可以联系QQ853974536（许兴逸）

如果您有兴趣，您可以直接向仓库推送支持平台的pull request，但我们不会接受：