Skip to content

qaqFei/easy-phi

Repository files navigation

easy-phi

easy-phi

License: MIT Language

easy-phi is a library written in C++ to rendering rhythm chart with no dependencies and all the platforms are supported.

Games Supported

  • Phigros

Features

  • High Performance: Optimized for performance, suitable for real-time rendering.
  • Simple API: Easy to use and understand.
  • Cross Platform: Works on any platform that supports C++.
  • Zero Dependencies: No external libraries are required.

Working On

  • Takeover: The library assumes full control over the rendering pipeline, handling all complex operations internally so that you do not need to manage any low-level details.

  • Documentation: We're working on comprehensive documentation to help you get started with easy-phi quickly and easily.

  • Making it Easier: We're making it easier to use easy-phi by clear and convient API design.

  • Supporting More Games: We're working on supporting more rhythm games, such as Milthm and Rizline.

Examples

For the completed example, check out here.

And the Open RPE Recorder is a subproject of this project, you can find it here, we also provide its release.

Building

Note: This library requires C++20 or later.

Library

Just include the easy_phi.hpp header file in your project and you're ready to go!

If you want to use some extra features, you can define the following macros (helpers module is required):

  • EASY_PHI_TEXT_RENDERER: Enable internal text renderer, using stb_truetype.

  • EASY_PHI_IMAGE_DECODER: Enable internal image decoder, using stb_image.

  • EASY_PHI_MINIAUDIO_AUDIO_ENGINE: Enable internal audio engine, using miniaudio.

Tests

Tests only supports Windows, and you need to install python and mingw-w64 that supports C++20 or later to build the test programs.

You can run the main test program by the following command:

python ./build_test.py --run --debug

License

This project is licensed under the MIT License.

Other

The charts in test_files are not owned by this project, please contact for removal if there is any copyright infringement.

We do not guarantee that the api is stable between versions.

About

A rhythm charts renderer by c++.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors