Skip to content

Latest commit

 

History

History
182 lines (123 loc) · 8.42 KB

README.md

File metadata and controls

182 lines (123 loc) · 8.42 KB
Raw

Mux

Mux provides data binding infrastructure to Unity.

Features

Mux is useful as a powerful UI toolkit on Unity, integrated with Mux.Markup.UI.

  • Fully Open-source including dependencies (except Unity itself)
  • Hackable
  • Text-based representation
  • No more clicking and dragging
  • Easy to merge
  • Fully managed
  • Full stacktrace
  • High portability
  • High stablity
  • Compiler-backed
  • Less overhead
  • uGUI-backed
  • Easy to migrate to/from uGUI
  • Powers Unity Editor Inspector
  • Has rich documentation
  • Xamarin.Forms-backed
  • Proven data template/data binding infrastructure for UI
  • Has rich documentation
  • Familiar for Xamarin.Forms/WPF developers
  • Minimal
  • High maintainability
  • Hot Reload
  • Fast iteration

Installation

Unity Editor must be 2020.2 or possibly newer.

First, add this repository to the Project manifest as com.pixiv.mux, a dependency.

You will need Mux.Markup.UI (com.pixiv.mux.markup.ui) if you would like to integrate Mux with uGUI. Mux.Markup.Animation (com.pixiv.mux.markup.animation) is for animation.

The target framework must be ".NET 4.x".

API

The following APIs are available:

Full APIs of System.Collections.Immutable

System.Collections.Immutable "provides collections that are thread safe and guaranteed to never change their contents, also known as immutable collections."

Xamarin.Forms XAML Runtime

Xamarin.Forms XAML compiler and markups in MS-XAML-2009 are available. The difference from the original runtime is that it compiles XAML by default.

You can also write your own markup extension using Xamarin.Forms.Xaml.IMarkupExtension. It can be annoted with Xamarin.Forms.AcceptEmptyServiceProviderAttribute, just like Xamarin.Forms markup extensions are.

DataTemplate and DataTemplateSelector are available.

Xamarin.Forms data binding infrastructure

In addition to markups in [MS-XAML-2009], a data binding infrastructure is proted from Xamarin.Forms. Specifically, it includes:

Mux APIs

Mux APIs provide Unity-specific runtime services and markups for Unity objects. Its documentation can be built with DocFX.

The playground and caveats

The documentation has a playground and exhibits examples with the component. However, there are something to be noted:

Building documentation

Building documentation requires the following:

  • MSBuild
  • NPM
  • Node.js

The following subprojects must be prepared as well:

  • Mux.Markup.Animation at .build/doc
  • Mux.Markup.UI at .build/doc
  • Xamarin.Forms modified for Mux at .build

Run Build target of .build/doc/doc.msbuildproj. PATH environment variable must be configured so that Unity, npm, and npx can be resolved.

DocFX Template

DocFX template used for the documentation is available at .docfx_template. It is also used for VRoid SDK documentation.

You need to merge it with the default template of DocFX to make it functional.

Incompatibility with IL2CPP

The Interpreter

IL2CPP does not provide the constructor arguments of custom attributes. Due to that restriction, important attributes such as Xamarin.Forms.ContentPropertyAttribute will not work with the interpreter.

A workaround is to use the compiler.

Data binding

Normal data binding relies on reflection, and Unity linker fails to figure out dependencies on a property. You have two options to resolve the problem:

  1. Use compiled bindings.

  2. Configure Unity Linker accordingly to prevent properties from being stripped.

See an article of Unity describing Unity linker.

Development

Coding Style

Mux conforms to the .NET Core C# Coding Style. Use modified CodeFormatter to format your code when developing Mux.

CodeFormatter /copyright:Copyright.txt CodeFormatter.rsp

Documentation

Provide documentations for public APIs. Please make sure DocFX does not emit any warnings nor errors.

Provide cross references to Unity with hyperlinks. You should check if the number of unresolved uid is increased by passing --logLevel Verbose when building the documentation.

Xamarin.Forms internal dependencies

Although modifications of Xamarin.Forms made for Mux is minimal, Mux depends on a number of internal interfaces:

Changes for those interfaces must be reviewed when altering Xamarin.Forms libraries.

External dependencies

Mux includes external dependencies. You can remove existing dependencies and recreate.

Run Clean target of .build/Mux.msbuildproj to clean all dependencies.

Run its Build target on Mono to recreate.

Licenses

See Licenses directory or "Licenses" article of the documentation.