io.extendreality.malimbe

Malimbe

A collection of tools to simplify writing public API components for the Unity software.

Introduction

Malimbe for the Unity software aims to reduce repetitive boilerplate code by taking the assemblies that are created by build tools and changing the assembly itself, new functionality can be introduced and logic written as part of the source code can be altered. This process is called Intermediate Language (IL) weaving and Malimbe uses Fody to do it.

Malimbe helps running Fody and Fody addins without MSBuild or Visual Studio and additionally offers running them inside the Unity software by integrating with the Unity software compilation and build pipeline. Multiple weavers come with Malimbe to help with boilerplate one has to write when creating Unity software components that are intended for public consumption. This includes a form of "serialized properties", getting rid of duplicated documentation through XML documentation and the [Tooltip] attribute as well as weavers that help with ensuring the API is able to be called from UnityEvents and more.

Releases

Branch	Version	Explanation
release		Stable, production-ready
preview		Experimental, not production-ready

Releases follow the Semantic Versioning (SemVer) system.

Getting Started

• Navigate to the Packages directory of your project.

• Adjust the [project manifest file][Project-Manifest] manifest.json in a text editor.

  • Ensure https://registry.npmjs.org/ is part of scopedRegistries.
    • Ensure io.extendreality is part of scopes.
  • Add io.extendreality.malimbe to dependencies, stating the latest version.

  A minimal example ends up looking like this. Please note that the version X.Y.Z stated here is to be replaced with the latest released version.

  {
    "scopedRegistries": [
      {
        "name": "npmjs",
        "url": "https://registry.npmjs.org/",
        "scopes": [
          "io.extendreality"
        ]
      }
    ],
    "dependencies": {
      "io.extendreality.malimbe": "X.Y.Z",
      ...
    }
  }
  

• Switch back to the Unity software and wait for it to finish importing the added package.

• Anywhere in your Unity software project add a FodyWeavers.xml file.

• Configure the various weavers Malimbe offers, e.g.:

  <?xml version="1.0" encoding="utf-8"?>
  
  <Weavers>
    <Malimbe.FodyRunner>
      <LogLevel>Error, Warning</LogLevel>
      <AssemblyNameRegex>^Zinnia</AssemblyNameRegex>
      <AssemblyNameRegex>^Assembly-CSharp</AssemblyNameRegex>
    </Malimbe.FodyRunner>
    <Malimbe.BehaviourStateRequirementMethod/>
    <Malimbe.MemberChangeMethod/>
    <Malimbe.MemberClearanceMethod/>
    <Malimbe.PropertySerializationAttribute/>
    <Malimbe.XmlDocumentationAttribute IdentifierReplacementFormat="`{0}`"/>
  </Weavers>
  

  As with any Fody weaver configuration the order of weavers is important in case a weaver should be applying to the previous weaver's changes.

  In case there are multiple configuration files all of them will be used. In that scenario, if multiple configuration files specify settings for the same weaver, a weaver will be configured using the values in the last configuration file found. A warning is logged to notify of this behavior and to allow fixing potential issues that may arise by ensuring only a single configuration exists for any used weaver.

Additional weavers are supported. To allow Malimbe's Unity software integration to find the weavers' assemblies they have to be included anywhere in the Unity software project or in one of the UPM packages the project uses.

Documentation

Check out the Documentation a further in-depth look at the features of Malimbe.

Contributing

If you want to raise a bug report or feature request please follow SUPPORT.md.

While we intend to add more features to Malimbe when we identify a need or use case, we're always open to take contributions! Please follow the contribution guidelines found in CONTRIBUTING.md.

Naming

Inspired by Fody's naming the name "Malimbe" comes from the small birds that belong to the weaver family Ploceidae.

Tools And Products Used

• Fody

License

Malimbe is released under the MIT License.

Third-party notices can be found in THIRD_PARTY_NOTICES.md

Disclaimer

These materials are not sponsored by or affiliated with Unity Technologies or its affiliates. "Unity" and "Unity Package Manager" are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere.

Changelog

9.5.1 (2019-10-14)

Bug Fixes

• ci: back to npmjs.com (563988f)

  GitHub's npm feeds only allow publishing scoped packages, but UPM doesn't support those.