RMC Readme Authoring

• How To Use
• Install
  • Via NPM
  • Via Git URL
  • Tests
  • Samples
• Configuration

How to use

This is a custom library to author a custom ReadMe for the Unity Inspector Window.

If you only want to display a custom ReadMe, see the https://github.com/SamuelAsherRivello/rmc-readme-authoring.

Install

Via NPM

You can either use the Unity Package Manager Window (UPM) or directly edit the manifest file. The result will be the same.

UPM

To use the Package Manager Window, first add a Scoped Registry, then click on the interface menu ( Status Bar → (+) Icon → Add Package By Name ... ).

Manifest File

Or to edit the Packages/manifest.json directly with your favorite text editor, add a scoped registry then the following line(s) to dependencies block:

{
  "scopedRegistries": [
    {
      "name": "npmjs",
      "url": "https://registry.npmjs.org/",
      "scopes": [
        "com.rmc"
      ]
    }
  ],
  "dependencies": {
    "com.rmc.rmc-readme-authoring": "1.1.9",
    "com.rmc.rmc-readme": "1.2.1"
  }
}

Package should now appear in package manager.

Via Git URL

You can either use the Unity Package Manager (UPM) Window or directly edit the manifest file. The result will be the same.

UPM

To use the Package Manager Window click on the interface menu ( Status Bar → (+) Icon → Add Package From Git Url ... ).

Manifest File

Or to edit the Packages/manifest.json directly with your favorite text editor, add following line(s) to the dependencies block:

{
  "dependencies": {
      "com.rmc.rmc-readme-authoring": "https://github.com/SamuelAsherRivello/rmc-readme-authoring.git",
      "com.rmc.rmc-readme": "https://github.com/SamuelAsherRivello/rmc-readme.git"
  }
}

Tests

The package can optionally be set as testable. In practice this means that tests in the package will be visible in the Unity Test Runner.

Open Packages/manifest.json with your favorite text editor. Add following line after the dependencies block:

{
  "dependencies": {
  },
  "testables": [ "com.rmc.rmc-readme-authoring" ]
}

Samples

Some packages include optional samples with clear use cases. To import and run the samples:

1. Open Unity
2. Complete the package installation (See above)
3. Open the Package Manager Window
4. Select this package
5. Select samples
6. Import

Configuration

• Unity Target - Standalone MAC/PC
• Unity Version - Any Unity Editor 2021.x or higher
• Unity Rendering - Any Unity Render Pipeline
• Unity Aspect Ratio - Any Unity Game View

Created By

• Samuel Asher Rivello
• Over 23 years XP with game development (2023)
• Over 10 years XP with Unity (2023)

Contact

• Twitter - @srivello
• Resume & Portfolio - SamuelAsherRivello.com
• Source Code on Git - Github.com/SamuelAsherRivello
• LinkedIn - Linkedin.com/in/SamuelAsherRivello <--- Say Hello! :)

License

Provided as-is under MIT License | Copyright © 2023 Rivello Multimedia Consulting, LLC