{"id":19615261,"url":"https://github.com/goma-recorder/playablemidi","last_synced_at":"2025-04-28T02:31:23.893Z","repository":{"id":37249030,"uuid":"315069991","full_name":"goma-recorder/PlayableMidi","owner":"goma-recorder","description":"This is a custom timeline/playables package that provides functionality to control object properties based on sequence data contained in a standard MIDI file.","archived":false,"fork":false,"pushed_at":"2021-01-31T11:16:56.000Z","size":37725,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-11T05:56:46.217Z","etag":null,"topics":["midi","unity"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/goma-recorder.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-22T15:32:52.000Z","updated_at":"2024-01-01T15:46:36.000Z","dependencies_parsed_at":"2022-08-18T19:11:33.882Z","dependency_job_id":null,"html_url":"https://github.com/goma-recorder/PlayableMidi","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goma-recorder%2FPlayableMidi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goma-recorder%2FPlayableMidi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goma-recorder%2FPlayableMidi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goma-recorder%2FPlayableMidi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/goma-recorder","download_url":"https://codeload.github.com/goma-recorder/PlayableMidi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224092001,"owners_count":17254152,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["midi","unity"],"created_at":"2024-11-11T10:56:01.257Z","updated_at":"2024-11-11T10:56:02.272Z","avatar_url":"https://github.com/goma-recorder.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Playable Midi\n\n![Ableton](https://i.imgur.com/yxJr18E.png)\n![Unity](https://i.imgur.com/aTMgdnB.gif)\n\n**Playable Midi** is a custom timeline/playables package that provides\nfunctionality to control object properties based on sequence data contained\nin a standard MIDI file (`.mid` file). This allows you to create musically\nsynchronized animation using a DAW (digital audio workstation) that is easy\nto manage accurately synchronized timings compared to other non-musical\ntimeline editors like Unity's one. Playable Midi is an extension of the [MIDI Animation Track](https://github.com/keijiro/MidiAnimationTrack).\n\n\n## System requirements\n\n- Unity 2020.1 or later\n\n## Dependency\n- [Midity](https://github.com/goma-recorder/Midity)\n\n## Installation\n\n### A. OpenUPM-CLI\n```\n$ openupm add jp.goma_recorder.midity.playable\n```\n[OpenUpm](https://openupm.com/packages/jp.goma_recorder.midity.playable)\n\n### B. Git url\n`Window -\u003e Package Manager -\u003e +▼ -\u003e Add package from git url`\n - `https://github.com/goma-recorder/PlayableMidi.git?#upm`\n \n ### C. Release page\n[here](https://github.com/goma-recorder/PlayableMidi/releases)\n\n## Importing .mid files\n\nYou can import a `.mid` file as an asset file. Simply drag and drop it to the\nproject view, or navigate to \"Assets\" - \"Import New Asset...\".\n\nAn imported asset may contain multiple tracks that are shown as sub-assets\nunder it.\n\n![Sub-assets](https://i.imgur.com/tuBe3py.png)\n\nTo create a MIDI animation track, drag and drop one of these clip assets to\na timeline.\n\n![Drag and drop](https://i.imgur.com/WVMaG6J.gif)\n\n## Track controls\n\nYou can animate object properties from a MIDI animation track using **track\ncontrols**. To create a new track control, select a MIDI animation track (not a\nclip) in the Timeline editor. Then track control editor will appear in the\ninspector.\n\n![Track controls](https://i.imgur.com/uOwwWKR.gif)\n\nA track control only can animate a single property. You can add multiple\ncontrols to animate multiple different properties.\n\nAt the moment, a track control only supports `float`, `Vector3`, `Quaternion`\nand `Color` properties. Please note that it requires a public *property* to\nbe animated; Just providing a public *variable* is not enough.\n\nThere are three modes in the track control: **Note Envelope**, **Note Curve**\nand **CC**.\n\n### Note Envelope mode\n\n![Inspector](https://i.imgur.com/7SFMCk9.png)\n\n**Note Envelope** is a mode where a property is animated by a classic [ADSR]\nstyle envelope. This mode is useful when you want to make animation react to\nkey-off events.\n\nYou can specify which **Note/Octave** the control reacts to. Please note that\nkey velocity affects the envelope. It's simply multiplied to the envelope\noutput.\n\n[ADSR]: https://en.wikipedia.org/wiki/Envelope_(music)\n\n### Note Curve mode\n\n![Inspector](https://i.imgur.com/YFATPN0.png)\n\n**Note Curve** is a mode where a property is animated by an animation curve.\nIt starts playing animation on key-on events and keeps playing until it ends\n(key-off events will be ignored).\n\nYou can specify which **Note/Octave** the control reacts to. Please note that\nkey velocity affects the animation curve. It's simply multiplied to the curve\nvalue.\n\n### CC mode\n\n![Inspector](https://i.imgur.com/ERFtPKL.png)\n\n**CC** is a mode where a property is animated by CC (control change) events\ncontained in a MIDI track.\n\nYou can specify which **CC Number** the control reacts to.\n\n## MIDI signals\n\nA MIDI animation track also supports sending [Timeline Signals] on key-on/off and some Meta\nevents. To receive MIDI events from a track, you can use the **MIDI Signal\nReceiver** component.\n\n[Timeline Signals]:\n    https://blogs.unity3d.com/2019/05/21/how-to-use-timeline-signals/\n\n![Inspector](https://i.imgur.com/LAwiWel.png)\n\n1. Add the MIDI Signal Receiver component to a game object that receives MIDI\n   signals.\n2. Specify which **Note/Octave** the receiver reacts to.\n3. Register methods to **Note On/Off Events**.\n4. Set the receiver game object as the output destination of the track.\n\n![Output destination](https://i.imgur.com/PqYi9cN.gif)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoma-recorder%2Fplayablemidi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgoma-recorder%2Fplayablemidi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoma-recorder%2Fplayablemidi/lists"}