Reminiscence persistent messages

INTRODUCTION

Reminiscence is a package inspired by the message system of souls-like games.
It contains a set of tools that allows both creators and players to create custom messages that persist between games:

HOW TO INSTALL

  • Go to community tab and install Reminiscence persistent messages package.
  • Go back to Library - Packages and drop down the installed package, it will be the last one in the list.
  • Drag & Drop User - Message System folder into User
  • Drag & Drop World - Messages Handler template into the hierarchy tree and set the Initial World Messages property to the amount of messages you want to load initially

HOW TO USE

The package is Drag & Drop ready so you don’t need any extra work to make it work, but if you want to change any of its settings you can do it in a simple way. Let’s take it one step at a time:

What is a persistent message?

A persistent message is a note you can add both in the editor and in-game that persist between sessions.
Messages contain the following information:

  • Phrase: Hello, *** | Is this a ***? | *** ahead
  • Word: Treasure | Arcade Machine | Baby | Secret | Enemy

By combining a phrase with a word, you can achieve all kinds of results, for example: Enemy ahead! | Look up | Don’t jump

  • Image
  • Upvotes
  • Downvotes
  • Creator
  • Controls

All of the info above is persistent but the name of the player who created the message, which is only saved during the session it is created. It is done that way in order to notify users when someone upvotes or downvoted their messages. You can find more info about that later.

Message creator for players

The possibility for players to create their own messages at will can be activated and deactivated from User - Message System - Can Create Messages
If you want players to be able to create messages only in certain areas you can use the Toggle Message Creation Trigger template to activate and deactivate it.

When players press extra2 button (Q on PC) and CanCreateMessages is enabled the message creator widget will pop up (above image).
Three different columns can be seen: phrases, words and images in that order. You can navigate through them with Previous and Next buttons.
Every time you click on a button the preview message will be updated so you can see how it will look like once published.

Note that you won’t see the publish button until you select a phrase, a word and an image. Otherwise you’ll only see the close button.

Phrases, words and images can be added, removed and changed from the messageCreatorWidget widget, Presets group

How to change the style

Player messages

The package comes with two predefined styles and the possibility to customise it to your liking without touching a single line of code as seen in the video above.

Go to User - Message System and you will find a property called currentStyle in the messageDisplayWidget and messageCreatorWidget widgets.
Both of them also have a group named Style Settings where you can customize from the container images to the text colors for each style:

World messages

World messages (World Message template) can also be customized through its properties in the worldMessageScript script and worldMessageWidget widget.
In the script you can change whether it is a message placed by the creators of the game or if it will be used by players in runtime. If they are predefined by the creators you can set its phrases and words presets or add a custom message. Remember that you have to use {word} in a phrase so it will be replaced but the word you choose:
Phrase: Hello, {word}
Word: player

You can change the widget properties directly with the asset properties exposed and add your own images and set them as highlight or default. To change the widget style change its currentStyle property.

How to change controls

Controls can be changed in User - Message System - messageSystemScript - Input group

Load messages

World Message Handler (world locator) - This template has what you need to load as many messages created by players as you want. From the worldMessagesHandlerScript script you can change these settings:

  • Initial world messages - Amount of messages that will be loaded and spawned. Consider that each message contains several entities or effects, so think about the performance of the game when changing this parameter.

  • Cooldown between spawns - You can load messages all at once or with a cooldown between each message (in seconds).

  • World Message Template - You can choose the type of message you want to load. There is a great variety of them, so you can use one type for messages predefined by the game creators, another for messages created by players, or even a different type depending on the area players are in.

  • Zone Prefix - This field is used to differentiate messages depending on the zone. For example, if your game has 2 different worlds or rooms you can define which messages you want to load from a particular one.

FAQ

Do you have any suggestions or found any bug? Let us know here or Discord: discord.gg/crayta

CREDITS

Rainarten - UI master
Unairf - Lua master

Showcase: Crayta

5 Likes
1 Like