Description

mini-info-smaller.png
MiniInfo in the inspector

Add a command that shows a buffer of text.

For static text that one wants accessible in their game, add MiniInfo and add the text.

Potential Uses

  • Game description
  • Game instructions
  • Release notes
  • High-minded philosophical gamedev treatise
  • Test instructions
  • License text

If the text is not static, consider using the Minibuffer.ToBuffer() method in a custom command like so:

[Command]
public void DescribeGameState() {
Minibuffer.instance.ToBuffer("game-state",
string.Format("Score: {0}\n"
+ "Round: {1}",
score,
round));
}

By default the command is "describe-<game-object-name>". One can also set a key binding.