Journal Entries provide a method for GMs to present and maintain hand-outs for their players. Entries are edited using a rich text editor (with HTML support gated behind a convenient 'source' button in the editor). Journal entries can be displayed to all players at the touch of a button, and conveniently "pinned" to the grid in any scene to allow for quick access to that entry.


The Journal Entries Directory

Journal entries are created and managed from the Journal Entries sidebar. Like the Scenes, Actors, and Items Directories, this directory can contain folders to organize your world's Journal Entries. Only a Gamemaster or Assistant-level user can change or move folders, but any players with at least Limited permissions for a Journal Entry can see it and the folder containing it.

As with all other entity directories, the "quill" icon on a Journal Entry folder will create a new journal entry inside that folder, and the "plus folder" icon will create a new subfolder.

A Journal Entry
An example Journal Entry in Text mode.

Journal Context Menu Options

Clear Folder
Removes the Journal Entry from all folders, placing it at the top level of the Journal Entries directory.
Delete
Deletes the Journal Entry, after accepting a confirmation prompt.
Duplicate
Creates a copy of the Journal Entry in the directory.
Configure Permission
Configure the permission levels of the Journal Entry, allowing players of your choice to view or modify the Journal Entry in the directory.
Export Data
Exports the Journal Entry's data as a JSON file on your computer.
Import Data
Imports data into the Journal Entry from a JSON file on your computer.

Text View and Image View

Journal Entries may have both a Text View and an Image View, which can be switched between by clicking the "Text" or "Image" buttons on the top menu of the Journal Entry.

Image view allows the GM or Owner to select an image using the Filepicker, and places the selected image in a shadow box, to allow a clean display of the image to players.

Text View provides a rich text editor using TinyMCE to allow for editing a text field that will be shown to your players. The GM or Owner can make numerous changes to the way the text is formatted using the menus at the head of the editor while in editing mode.

Foundry adds a custom formatting called Secret to text entries which will only be visible to the GM or Owner of the Journal Entry. You can create a Secret by selecting "Custom" and then "Secret" from the Paragraph formatting menu. If text is selected when you choose 'secret' it will change the selected text to Secret.

In addition to the formatting option available through TinyMCE, using the "Source Code" option from the formatting menu will allow you to edit the HTML of the journal entry directly, opening access to HTML tags and a vast array of custom styling.

Though not exclusive to Journal Entries, Foundry supports linking to other types of Entities from within its rich text editor system. Actors, Items, Journal Entries, and Rollable Tables may be linked to dynamically by dragging and dropping an entity from the sidebar into an open editor.

The syntax to create a dynamic link is as follows:

@EntityType[Entity Name]
@EntityType[Entity ID]{Custom Text}

For example:

@Actor[Locke]
@Actor[Pt1jPTgVWdJ6QYIA]{Locke}

This allows a GM to quickly link numerous journal entries to one another and, if the user viewing the Journal Entry has permission to view the linked entity, clicking on the link will open the linked entity in another sub-window of Foundry.

Journal Permission Levels

As with all other Entities, Journal Entries have levels of Permissions that when assigned allow them to view and edit those entries at differing levels. The levels of permission are:

None (default for non-creator)
The user has no permission to view or edit a Journal Entry by default.
Limited
The user may see the map pin for this Journal Entry but will not see it in the sidebar, and may not open the actual journal by clicking on the pin.
Observer
The user may see the map pin for this Journal Entry as well as the Journal Entry in the sidebar, and may open the actual journal by clicking on the pin or its entry in the sidebar. In addition, the user may toggle between Image view and Text view for that journal entry.
Owner (default for creator)
The user may see the map pin and sidebar entry for this journal, and when the window is open may edit and change any features of that Journal Entry.

Showing Journal Entries to Players

Journal entries may be shown to all players regardless of their permission to access the journal, simply click "Show Players" from the heading menu for any Journal Entry.


Creating Map Notes from Journal Entries

A Journal Entry can be 'pinned' to any scene, generating a Map Note that connects to that Journal Entry simply by dragging the entry from the sidebar to the location you would like to place a Map Note. For more information, see Map Notes.


Scene Notes

Scenes may be configured to provide easy access to a Journal Entry containing notes for that scene for the GM's convenient reference. To do so, from the scene configuration menu choose the Journal Entry you wish to associate with your scene from the Journal Notes dropdown menu.

These notes can be accessed quickly by right clicking the Scene Name in the Navigation Menu and choosing "Scene Notes."


API References

To interact with Journal Entry entities programmatically, you will primarily use the following API concepts: