RhythmEngine

Package: com.amanotes.magictilescore
Version: 0.4.0

Professional rhythm game framework for Unity providing state machine management, tile lifecycle, scoring systems, and timing synchronization.

Features

• 🎮 Complete rhythm game framework with 15-state machine
• 🎯 Flexible input system (touch, hold, swipe, drag)
• 🎨 Meta system for dynamic parameters
• 🚀 Knot system for path-based movement
• 🔧 Visual warp system for 3D transformations

Documentation

📄 View on Notion

Complete documentation: Docs/RhythmEngine-API.md

Guides:

• API Reference - Complete API reference
• Architecture Overview - Core system architecture
• Customization Guide - Implementation guide
• Systems/ - System guides (Meta, Knot, VisualWarp, Input)

Installation

Private Registry (Amanotes Internal)

Add to Packages/manifest.json:

{
  "dependencies": {
    "com.amanotes.magictilescore": "0.4.0"
  },
  "scopedRegistries": [{
    "name": "Amanotes Internal",
    "url": "https://gitlab.amanotes.net/api/v4/projects/592/packages/npm",
    "scopes": ["com.amanotes"]
  }]
}

Configure authentication in ~/.upmconfig.toml:

[npmAuth."https://gitlab.amanotes.net/api/v4/projects/592/packages/npm"]
token = "YOUR_GITLAB_PERSONAL_TOKEN"
alwaysAuth = true

Local Development

{
  "dependencies": {
    "com.amanotes.magictilescore": "file:../LocalPackages/MagicTilesCore"
  }
}

Quick Start

public class MyGame : RhythmGameT<MySongNote, MyMatch>
{
    protected override MyMatch CreateMatchData() => new MyMatch();
}

public class MyTile : MonoBehaviour, IRhythmTile, IPoolPrefab
{
    public void OnGet() { }
    public void OnReturn() { }
}

API Reference

Key Classes

RhythmGameT<TSongNote, TMatchData>

• Purpose: Base game class for rhythm games
• Key methods: CreateMatchData(), OnGameStart(), OnGameEnd()

RhythmContext

• Purpose: Central coordinator for all systems
• Key properties: config, audioPlayer, pool, tileMap

TileContext

• Purpose: Data bridge between note and visual tile
• Key properties: note, tile, status, progress

RhythmConfig

• Purpose: Configuration ScriptableObject
• Key properties: mp3Offset, touchLatency, visualSpeed

See: Complete API Reference

Dependencies

• Unity 2021.3+
• TextMeshPro
• RhythmJson (com.amanotes.rhythmjson)

Version History

See CHANGELOG.md