com.rmc.rmc-readme
v1.2.2
Published
ReadMe library for Unity Development by Rivello Multimedia Consulting
Downloads
255
Maintainers
Readme
RMC Readme
How to use
This is a custom library to display a custom ReadMe for the Unity Inspector Window.
If you also want to author 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": "1.2.2"
}
}
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": "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" ]
}
Samples
Some packages include optional samples with clear use cases. To import and run the samples:
- Open Unity
- Complete the package installation (See above)
- Open the Package Manager Window
- Select this package
- Select samples
- Import
Configuration
Unity Target
- Standalone MAC/PCUnity Version
- Any Unity Editor 2021.x or higherUnity Rendering
- Any Unity Render PipelineUnity 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