DOCSEARCHbyAlgolia
Submit Docs

Phichain Documentation

website·Indexed 29 days ago

https://phichain.rs

A toolchain for Phigros chart creation, featuring a desktop editor, a converter for various chart formats (including RPE JSON and official formats), and a renderer for converting charts to video. The documentation covers Phichain Format 6, project structure, resource pack (Respack) specifications, and detailed guides on notes, events, and timing.

Tokens
11.9K
Snippets
37
Records
110
Agent score
50%

What's inside Phichain

  1. Overview of Phichain Renderer

    The Phichain Renderer is used to render Phigros chart files into video format. Note that this is currently an experimental feature and may contain incomplete functionality or unexpected behavior.

  2. Configure basic chart information in the Chart Basic Settings window

    The 'Chart Basic Settings' window allows you to define the fundamental metadata and timing for a chart. The available fields include:

    • Offset (延迟): The delay of the chart relative to the music, measured in milliseconds (ms).
    • Name (名称): The name of the chart, typically the name of the music. This is displayed in the bottom-left corner of the preview window.
    • Difficulty (难度): The difficulty level of the chart, displayed in the bottom-right corner of the preview window. Recommended format: EZ/HD/IN/AT/SP + Lv.x (e.g., HD Lv.10).
    • Composer (曲师): The music composer, displayed below the music name in the song selection and loading screens.
    • Charter (谱师): The person who created the chart, displayed on the loading screen.
    • Illustrator (画师): The artist who created the song's artwork, displayed on the loading screen.

  3. Understand the Official Phigros Chart Format and Phichain Conversion

    The official chart format is the native format used by the Phigros game engine. Unlike the Phichain format, the official format does not support easing (non-linear events). When converting a Phichain chart to the official format, all non-linear events are approximated by being split into multiple short, linear events to simulate the easing effect.

  5. Phichain Project Overview and Support

    Phichain is an open-source toolchain for creating Phigros charts, developed using Rust. Because the project is currently in an iterative phase, features may undergo significant changes. Users encountering issues are encouraged to report them via GitHub Issues.
    GitHub Issues: https://github.com/Ivan-1F/phichain/issues

  6. Understand Phichain Resource Pack (Respack) contents

    A Resource Pack (Respack) is a collection of all replaceable visual and audio assets for Phichain game screens. A complete respack contains:

    • Textures for four note types (Tap, Drag, Hold, Flick), each with normal and highlight variants.
    • Judgment line textures.
    • Animation atlases for hit effects.
    • Hit sound effects for three note types (Tap, Drag, Flick).

  7. Understand Phichain telemetry data collection

    Starting from v1.0.0-beta.3, Phichain toolchains collect anonymous telemetry data to help developers analyze usage, fix bugs, and optimize performance. The data does not include personal or sensitive information such as environment variables, file paths, file contents, or chart information.

    Collected data includes:

    • Timestamp and event type.
    • A unique UUID v4 for the current instance (regenerated every launch, not persisted).
    • An encrypted device identifier.
    • Phichain version (including beta status) and toolchain name (e.g., phichain-editor, phichain-converter, phichain-renderer).
    • System info: OS type (Windows, macOS, Linux), version, and architecture (e.g., AMD64).
    • Hardware data: wgpu adapter info and general system info.
    • Environment info: Whether running in a container, CI, or debug environment.
    • Event-specific metadata.

  8. Phichain Chart Format Version 6 Overview

    The Phichain chart format is used by the chart editor and supports advanced features. The current version is 6. When opening a chart created with an older version in the editor, the editor will automatically attempt to migrate the chart to the latest version.

  9. Download Phichain binaries

    Phichain provides pre-compiled binaries for multiple platforms. Users can choose between the latest beta version (v1.0.0-beta.7) or the latest stable version (v0.5.0) based on their operating system and architecture (Apple Silicon, Intel, Windows x86_64, Windows ARM64, or Linux x86_64).

  10. Phichain project workspace structure

    Phichain is organized as a standard Cargo workspace consisting of several specialized crates for handling Phigros charts, including libraries for format conversion, asset management, and binary tools for editing and rendering.

  12. Convert Phigros charts using Phichain

    Phichain provides a converter tool specifically for transforming Phigros chart files from one supported format to another. For a detailed list of compatible chart formats, refer to the core chart format documentation.