Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For comparison, if I load a module that I know has a reference manualReference Manual... let's say the D&D Dragon of Icespire Peak module, you'll see what a populated campaign book looks like vs. what we see for the the editor.

...

  1. Previous Page - Display the previous page to the current one as listed in the Campaign index.

  2. Open Story Book - This will open the main Campaign book that this page was opened from.

  3. Next Page - Display the next page after the current one in the as listed in the Campaign index.

  4. Window Resize Drag Handle - This allows you to easily resize the window freely in all directions.

Note

With the v4.5.0 release, some page items and functionality may have changed and may not be reflected in the older screenshots or information as seen below. Text formatting functionality, overall, should work almost the same.

We are in the process of actively updating all documentation to match v4.5.0 feature updates. Please check back shortly for updated information.

Page Content Types

The Text Element

The text element is used to create one or more paragraphs that will run the full length of the page, essentially giving you a means to provide as much or as little detail as you might like to enter. 

There are no format controls within the element, and what you enter is what you will see once the manual has been exported, or the page has been locked.

This means it will include all spaces that you enter, as well as ensure any new lines that you’ve created will be retained, so you can space the content out as much as you like, or cram it all into one large paragraph - though that would be slightly less useful for your readers.

...

It should be noted that all text fields work as though you are editing a story page, and this means that you can change a font from a normal font to a bold or italicized font, or make use of different formatting options that you would otherwise use in a story.

This includes lists, tables, chat frames and all other sorts of options

All you have to do is right click within the text entry box to bring up the context menu that will give you the options, much like you would for a story page.

...

Page Content Types

The Text Element

The text element is used to create one or more paragraphs that will run the full length of the page, essentially giving you a means to provide as much or as little detail as you might like to enter. 

There are no format controls within the element, and what you enter is what you will see once the manual has been exported, or the page has been locked.

This means it will include all spaces that you enter, as well as ensure any new lines that you’ve created will be retained, so you can space the content out as much as you like, or cram it all into one large paragraph - though that would be slightly less useful for your readers.

...

It should be noted that all text fields work as though you are editing a story page, and this means that you can change a font from a normal font to a bold or italicized font, or make use of different formatting options that you would otherwise use in a story.

This includes lists, tables, chat frames and all other sorts of options

All you have to do is right click within the text entry box to bring up the context menu that will give you the options, much like you would for a story page.

...

Info

For more information about Stories and formatting text, please see the following articles/sections elsewhere in our wiki:
Link: https://fantasygroundsunity.atlassian.net/wiki/spaces/FGCP/pages/996640055/Basic+Actions#Text-Fields
Link: https://fantasygroundsunity.atlassian.net/wiki/spaces/FGCP/pages/2017230849/FGU+Quick-Start+for+GMs+DMs+Part+1+-+Preparing+An+Adventure#Start-With-A-Story

...

These options give you another means to change the appearance of your manual, and help provide an interesting display of the information you're trying to convey.

...

Moving all elements

Just like the contents of the left menu, it's also possible to shift the position of elements on a given page, so if you realize a little after you started adding content, that a header might help present the information better, you can add it, then move it to the desired location on the page. 

However any element that is a split element, such as the split text element, as well as the split text and image elements are moved as one, so both sides of the element are moved up or down when you adjust the element using the up and down arrows. This ensures that as you move those elements around, they stick together.

...

Another thing to note, is that an element can’t be shifted to a different page using this method, and you’ll need to create a new element in the target page, and copy/paste the text into that element. 

Images can not be moved this way, and instead you will simply need to drag the asset into the new image element on the new page.

Exporting The Reference Manual

Lastly, it's also possible to export the manual as part of a module, and while we did not cover module development in this video, I can very quickly show you how to ensure your manual is included in an exported module at the time you're ready to complete that export.

Once again, you’ll want to access the modules information panel from the Library drop down category. 

You’ll see next to the builder button, the export button which once clicked will display the export information panel.

...

There are a large number of options that are beyond the scope of this video, there is only one location we need to focus on right now and that’s under the “Exported record Types” in the middle of the export panel.

If you scroll down to almost the bottom of the list, you’ll see there’s an entry for the “Reference Manual”, this should be checked to ensure it's exported at the time your module is exported as a whole.

...

However, it is possible to simply create a module that contains nothing but this manual, and it's a great way to create a custom set of guidelines and rules for your groups that you edit through a master module, export it and load it into your various campaigns so it can be provided to players.

You’ll want to ensure you also select the “Player Module?” Option just above the “Exported record types” listing, to ensure players can load it on their side.

...

Reference Manual Video Tutorial

In this video, Stoehovve introduces the new manual builder that has been added to Fantasy Grounds Unity. Through this demonstration, he covers all aspects of the manual builder, as well as how to include the manual as part of an exported module.

...

to change the appearance of your manual, and help provide an interesting display of the information you're trying to convey.

...

Moving all elements

Just like the contents of the left menu, it's also possible to shift the position of elements on a given page, so if you realize a little after you started adding content, that a header might help present the information better, you can add it, then move it to the desired location on the page. 

However any element that is a split element, such as the split text element, as well as the split text and image elements are moved as one, so both sides of the element are moved up or down when you adjust the element using the up and down arrows. This ensures that as you move those elements around, they stick together.

...

Another thing to note, is that an element can’t be shifted to a different page using this method, and you’ll need to create a new element in the target page, and copy/paste the text into that element. 

Images can not be moved this way, and instead you will simply need to drag the asset into the new image element on the new page.

Exporting The Campaign

Lastly, it's also possible to export the campaign as part of a module, and while we did not cover module development in this video, I can very quickly show you how to ensure your manual is included in an exported module at the time you're ready to complete that export.

Once again, you’ll want to access the modules information panel from the Library drop down category. 

You’ll see next to the builder button, the export button which once clicked will display the export information panel.

...

There are a large number of options that are beyond the scope of this video, there is only one location we need to focus on right now and that’s under the “Exported record Types” in the middle of the export panel.

If you scroll down to almost the bottom of the list, you’ll see there’s an entry for “Story”. This should be checked to ensure it's exported at the time your module is exported as a whole.

...

However, it is possible to simply create a module that contains nothing but this manual, and it's a great way to create a custom set of guidelines and rules for your groups that you edit through a master module, export it and load it into your various campaigns so it can be provided to players.

You’ll want to ensure you also select the “Player Module?” Option just above the “Exported record types” listing, to ensure players can load it on their side.

...