/EasyTimeline

Now you can edit Component/Volume fields in Unity Timeline more easily without writing code

Primary LanguageC#MIT LicenseMIT

TimelineExtensions

English | 中文

Introduction

A code generator tool for Unity Timeline that creates extension code for Volume or Component without writing code manually. It helps rapid prototyping and allows for easy customization of additional logic. Non-complex generated code can be directly imported into projects.

At present, there are some extensions to the original Post-Processing Volume of Unity URP, which are used to dynamically adjust the volume in the Timeline
It can be directly imported into the project for use, or quickly expand through the "MAO Timeline playable Wizard" tool.

Features

Currently supported parameter types in Component/Volume mode:

  • Common basic fields (int, float, bool, Vector, Color, Texture, etc.)
  • FloatParameter
  • IntParameter
  • BoolParameter
  • Vector2Parameter
  • Vector3Parameter
  • Vector4Parameter
  • ColorParameter
  • TextureParameter
  • Enum (e.g., Depth of Field's Gaussian or Bokeh modes. Code generation is supported, but the Clip's Inspector panel will list all options at once - you may need to customize the Clip's panel)

Currently unsupported or not fully tested:

  • LayerMaskParameter
  • FloatRangeParameter
  • RenderTextureParameter
  • CubemapParameter
  • ObjectParameter
  • AnimationCurveParameter
  • TextureCurveParameter

Usage

Typical usecase

  1. Open the Timeline window and create a new Timeline.
  2. Create a new Global Volume, add TimelineExtensionVolumeSettings component.
  3. Add a new Track which starts with "MAO", such as MAOBloom.
  4. Set TrackBinding to the TimelineExtensionVolumeSettings component.
  5. Add a new Clip to the Track, edit properties in the Clip or mix with other Clips.

TimelineExtensionVolumeSettings component settings:

  • VolumeAccessType:
    • Profile: Access a copy of the profile, which will not affect the original volume profile file (but if you adjust the Volume property through Timeline in Editor mode and then manually adjust it, this modification cannot be saved)
    • Shared Profile: Access a reference to the profile, which will directly affect the original volume profile. The settings cannot be reset after exiting play mode

Tip

It is recommended to use Shared Profile in Editor mode and Profile in Play mode.
If you need to use this switching method, you can check AutoSwitchType in TimelineExtensionVolumeSettings
For more information, please refer to Unity Documentation

VolumeComponent:

  1. You can find it in the menu bar Window/MAO Timeline Playable Wizard

  2. Switch WorkType to VolumeComponent, select the Track Binding Type

  3. Set Default Values to the Volume

  4. Add the properties

  5. Finally, click Create, wait for the compilation to complete and start enjoying~
    You can find it in Assets/TimelineExtensions

Important

The Enum type is currently not supported. When you need it (such as Gaussian or Boken's DOF), it is recommended to create it in the following way.

Advanced Settings

You can customize the generated code path and default namespace through TimelineExtensions/Resources/MAOTimelineExtensionsConfigSO.

The namespace affects how the Track appears in the context menu when adding a Track in Timeline. When a namespace is present, the corresponding Track will be generated in a submenu; otherwise, it will appear in the root menu.

License

MIT License

Credits