Skip to content

A Foundry VTT module that allows users to create small notes, reminders, counters and other planning tools and share them with other users

License

Notifications You must be signed in to change notification settings

Saibot393/notebook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notebook

This module adds a new tab named "Notebook" to the right sidebar. Both players and GMs can create small notes here and share them with others.

Basic notes

Basic notes have a title and can be colored for easier recognition. The GM can always see all notes and also delete them. The owner (the user who created the note) may choose who can see and who can edit the note. The notes may be reordered via drag and drop and can be minimized by clicking on the black title bar. The notes can also be expanded into seperate windows by using the popout symbol in the notes title bar. To copy a note, you can shift+right-click the title bar (the copies permissions will be reset).

Certain notes (text, list, chat) can be copied into journals via drag and drop.

Please note:
  • The notes are saved per user. To edit a note you have access to, either the owner of the note or a GM has to be online.
  • The folder structure is per user and is not snyched. Every user can have their own folders for their own purposes
Multiple types of notes are available:
  • Text notes:

    A simple note that allows you to share small texts

    imag

  • Counter notes:

    A note to count, well, something. You can add or subtract using the "+" and "-" buttons to the left and to the right. Holding shift or alt will alter the amount changed by using the buttons and holding the buttons will quickly increase or decrease the value. The value can also be set directly by writing into the counter. A maximum can also be set by entering a "/" followed by the maximum into the counter.

    imag

  • List notes:

    A note to list some items. The items can be checked/unchecked or removed. The notes can be indented using Tab or shift + Tab and can be reordered using drag and drop. The check state of sub states can be set using right-click.

    imag

  • Slider notes:

    A value slider. The value can be set via the slider or via the input to the right. By hovering over the bar at the bottom a menu will open, allowing you to set maximum, minimum and step size of the slider.

    imag

  • Chat notes:

    A chat allowing all users that can edit the note to chat with all users that can see the note. The chat colors are based on the user colors.

    imag

  • Timer notes:

    A timer that counts even while the user is offline or the server is down. The time (seconds, minutes, hours and days(top left)) can be set directly by entering the values. Using the menu to the right, that appears when hovering over the note, the direction in which the timer ticks can be chosen (up or down), the timer can be started or paused, and the timer can be reset to 0 (if the timer ticks up) or reset to the last manually set time (if the timer ticks down).

    imag

  • Progress Clock notes:

    A progress clock whose segments can be turned on or off by clicking. Scrolling while holding shift increases or decreases the number of filled segments. The number of total segments can be changed in the menu to right which appears when hovering over the bar at right.

    imag

  • Round Counter notes:

    A counter ticking up or down every time a round passes. Both the direction (up, down) and a limit can be set.

    imag

  • Macro notes:

    A list of macros that can be executed with left-click. Macros can be added reordered using drag and drop and removed using shift + right-click. Rigth-click can be used to edit macros.

    imag

  • Enhanced Text notes:

    A text note that can include the normal foundry inline rolls and entity links. In addition counters ([[number]] or [[number/number]]) and online images (added via drag and drop) can be added. The edit mode of the note can be accessed via the edit button at the top right that appears when hovering the note

    imag

  • Scribble notes:

    A note for freehand drawing. The color is determined by the player color. The eraser symbol at the top right can be used to delete own drawing, the owner can use shift + click to delete all drawings

    imag

Settings:

Client:

  • Shift quick create: Note type created when creating note while holding shift
  • CTRL quick create: Note type created when creating note while holding CTRL
  • ALT quick create: Note type created when creating note while holding ALT
  • Small note height: Height some note types collapse to when the mouse leaves
  • Large note height: Height some note types expand to when the mouse enters
  • Note background: Background pattern of notes

Languages:

The module contains an English, a German, and a Japanese (thanks to doumoku) translation. If you want additional languages to be supported let me know.


If you have suggestions, questions, or requests for additional features please let me know.

About

A Foundry VTT module that allows users to create small notes, reminders, counters and other planning tools and share them with other users

Resources

License

Stars

Watchers

Forks

Packages

No packages published