How to make a cool readme like this?

Unity Engine
1

So, today i downloaded the 2d game kit to check it out and saw that it had a nice looking Readme file inspector (below) and would like to make something like that for an asset im making. Is that just a custom inspector? Any ideas on how to create something similar? Thanks!

1 Like
2

I think it’s a .asset file. Open that up with MonoDevelop or a code editor of your choice and you should see the code of it?!

1 Like
3

i got this, i guess i can reverse it, im mostly stuck on the picture but nothing unsolvable after a couple minutes. thanks!

%YAML 1.1
%TAG !u! tag:unity3d.com,2011:
— !u!114 &11400000
MonoBehaviour:
m_ObjectHideFlags: 0
m_PrefabParentObject: {fileID: 0}
m_PrefabInternal: {fileID: 0}
m_GameObject: {fileID: 0}
m_Enabled: 1
m_EditorHideFlags: 0
m_Script: {fileID: 11500000, guid: fcf7219bab7fe46a1ad266029b2fee19, type: 3}
m_Name: Readme
m_EditorClassIdentifier:
icon: {fileID: 2800000, guid: 6756ed7b80223ac4e8f026ce27541de4, type: 3}
title: ‘Explorer: 2D Game Kit’
sections:

  • heading: What is a Gamekit?
    text: This game kit empowers you to create your own 2D platformer game without
    writing any code.
    linkText:
    url:
  • heading: How do I use it?
    text: We’ve written a detailed manual that explores all the available prefabs
    and components that make up the mechanics in this kit. You can find the manual
    on our Learn site.
    linkText: Read the manual
    url: 2D Game Kit - Unity Learn
  • heading: Got feedback?
    text: 'Let us know what you think or ask sdcdsdsdfsdfdf questions you might have on our FORUM. ’
    linkText: Forum Thread
    url: 2D Game Kit Official Thread
    loadedLayout: 1
4

Building a Custom Inspector

2 Likes
5

I was wondering the same thing when I found this post! Unfortunately, more googling found no additional information about how to do this, so I had to figure the rest of it out on my own.

Anyway, the trick is to click the dropdown to the right of the Readme’s Inspector tab and pick the “Debug” option. Then you can change the icon, the text, everything…

I even made a GitHub project with the code from Unity’s tutorials, so you can download a pre-made package and add Readme tabs to any project. The full tutorial on how to edit Readme inspector tabs is in the Readme that is added when you import the package. GitHub - JohnAlbin/UnityReadme: Add a Readme / Tutorial to the inspector tab of your Unity project

13 Likes
6

@JohnAlbin Thanks for doing that, that’s great!

7

To create the ReadmeEditor I just have to create a normal C# script and edit it.
Same for Readme ScriptableObject.
How do you create the readme asset file containing the YAML content from inside the editor ?
Do I have to create it from outside the unity editor ?

8

@JohnAlbin how do we create the final readme file ?
Do we just make a file outside of unity ?

9

Just add the CreateAssetMenu attribute to the Readme.cs

e.g

[CreateAssetMenu( fileName = "Readme", menuName = "ScriptableObjects/Readme", order = 5 )]
public class Readme : ScriptableObject
1 Like
10

It would be cool to use this for a game developer to do list could it be made interactive?

11

Thanks for the tip, @JohnAlbin !

12

You Are Awesome! this works, thank you!