Skip to content

Instantly share code, notes, and snippets.

@KageDesu
Created November 15, 2024 23:18
Show Gist options
  • Save KageDesu/69c991a123c7fc8e5307f1408c416b23 to your computer and use it in GitHub Desktop.
Save KageDesu/69c991a123c7fc8e5307f1408c416b23 to your computer and use it in GitHub Desktop.
Message History Plugin Guide

Message History Plugin Guide

Message History is a plugin for RPG Maker MZ and MV that allows you to view a log of messages displayed in the game. This log can be useful for players who want to review the dialogue or story events they've encountered during gameplay.

Features:

  • All messages displayed using the Show Text event command will be logged in the history window.
  • Player choices logged as well. But it's optional and can be disabled in the plugin settings.
  • Using script calls you can disable or enable writing to the history log and access to the history window.
  • Optional button to open the history window from the game scene. And menu command to open the history window from the main menu.
  • Plugin based on NUI, that allows customizing the appearance of the history log and messages and automatically scales to the screen size.
  • You can customize the appearance of the history log and messages by editing the .json files and images provided with the plugin.

Script Calls API:

  • OpenMessageHistory(); - Opens the message history window if it's available. Used for opening the window from the game scene.

  • OpenMessageHistoryScene(); - Opens the message history scene (force open).

  • ClearMessageHistory(); - Clears the message history log.

  • AllowWriteToMessageHistory(); - Allows writing messages to the history log. By default, this is enabled.

  • DisallowWriteToMessageHistory(); - Disallows writing messages to the history log.

  • AllowAccessToMessageHistory(); - Allows access to the message history window. By default, this is enabled.

  • DisallowAccessToMessageHistory(); - Disallows access to the message history window.

  • IsMessageHistoryAllowed(); - Returns true if writing to the history log is allowed.


Customizing History Log:

  • You can modify the appearance of the history log and messges by editing the .json files located in: data\PKD_MessageHistory\ (all files starting with NUI_).

  • Images used in the history log are stored in the img\PKD_MessageHistory\ folder. You can replace these images with your own to customize the appearance of the log.


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment