Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ivan-1f/phichain/llms.txt

Use this file to discover all available pages before exploring further.

​
What is the Phichain Editor?

The Phichain editor is a visual chart editing tool for creating Phigros-style rhythm game charts. Built with Rust using the Bevy game engine and egui UI framework, it provides a modern, real-time editing experience with immediate visual feedback.

​
Key Features

Visual Timeline

Edit notes and line events on an intuitive scrolling timeline with beat-accurate snapping

Real-time Preview

See your chart come to life with integrated playback and rendering

Multi-line Support

Manage multiple judgment lines with independent events and animations

Advanced Events

Create complex line animations with easing functions and precise timing

​
Architecture

The editor is built on a robust technical foundation:
  • Bevy ECS: Leverages Bevy’s Entity Component System for efficient data management and rendering
  • egui: Provides the immediate-mode UI with dock-able panels and responsive controls
  • Command Pattern: Full undo/redo support through an immutable command history
  • Plugin Architecture: Modular design with separate systems for editing, rendering, audio, and UI

​
Main Workflow

1

Create or Open Project

Start a new chart or open an existing .pec file from the home screen
2

Configure Chart Settings

Set up basic chart metadata, BPM, offset, and audio file
3

Add Judgment Lines

Create lines and configure their initial properties
4

Place Notes

Use hotkeys (Q/W/E/R) to place tap, drag, flick, and hold notes on the timeline
5

Add Line Events

Create movement, rotation, speed, and appearance events for dynamic animations
6

Test & Refine

Play back your chart, adjust timing, and polish the experience
7

Export

Export to various formats for distribution or further processing

​
Editor vs CLI Tools

​
When to Use the Editor

  • Creating charts from scratch with visual feedback
  • Placing and adjusting notes interactively
  • Designing complex line animations
  • Testing playback in real-time
  • Making quick iterations and adjustments

​
When to Use CLI Tools

  • Batch processing multiple charts
  • Automated format conversion
  • Integration with build pipelines
  • Scripted chart generation or modification
  • Rendering videos without opening the editor
The editor and CLI tools complement each other. You can use the editor for creative work and CLI tools for automation and batch operations.

​
Project Structure

The editor organizes your work into projects, each containing:
  • Chart data: Notes, lines, and events (.pec format)
  • Audio file: Music track for the chart
  • Settings: Chart metadata, BPM list, and offset
  • Assets: Background images, illustration, and other resources

​
Getting Started

Ready to start charting? Check out the Interface Guide to learn about the editor layout, or jump straight to Basic Charting to place your first notes.

Interface Guide

Learn about panels, timelines, and controls

Basic Charting

Start creating your first chart

Advanced Features

Master complex animations and workflows

Keyboard Shortcuts

Speed up your workflow with hotkeys

Build docs developers (and LLMs) love

Get started for freeTalk to us