typhonjs-fvtt / typhonjs-quest-log

This module provides comprehensive Quest Log system for players and Game Masters to use with Foundry Virtual Tabletop
Other
19 stars 0 forks source link

FoundryVTT - TyphonJS Quest Log

Foundry Core Compatible Version GitHub release GitHub commits the latest version zip Forge installs PRs Welcome Foundry Hub Endorsements

NOTE This is a new quest log module which continues from Michael's / TyphonJS' work on the 0.7.x series of Forien's Quest Log. A whole new UI / tech stack based on Svelte and utilization of the TyphonJS plugin manager / eventbus is forthcoming. Many new features are planned for the TyphonJS Quest Log providing a high performance quest runtime for Foundry VTT.

When officially launched there will be a migration path for users of Forien's Quest Log to update to the TyphonJS Quest Log.

[Compatibility]: FoundryVTT v10+

[Systems]: any

[Languages]: Chinese, English, French, German, Japanese, Korean, Polish, Portuguese (Brazil), Spanish, Swedish

This module provides comprehensive Quest Log system for players and Game Masters to use with Foundry Virtual Table Top

Installation

Presently TQL is in development and is not officially released. The initial release should be available in the summer / Q3 '22.

Usage

A button to access the Quest Log is situated on the bottom of Journal Directory or in the scene controls menu under notes / journal entries on the left-hand navigation bar where a scroll icon opens the Quest Log.

TQL is quite user-friendly with an intuitive UI, however you might want to check out the Wiki for more detailed usage including macros and Quest API details for external developers integrations.

Being a new module that shares ancestry with Forien's Quest Log the following in-depth of useful in depth video tutorials on YouTube are applicable to the TyphonJS Quest Log:

Features

Future plans (current ideas)

Plans for future include:

You can always check current and up-to-date planned and requested features here

If you have any suggestion or idea on new contents, hit me up on Discord!

Translations

If you are interested in translating my module, simply make a new Pull Request with your changes, or contact me on Discord.

How to contribute

Please leave your preferred attribution name and optional email address in the AUTHORS file. Your GitHub noreply address can be found with this tool (use <id+username@users.noreply.github.com>).

How to translate

The English translation of this module is maintained, so you check on that one to see how a translation file should look. It can be either expanded (nested) JSON like English, or flat JSON like Polish.

Order of Localization Strings inside a .json file is indifferent.

Localization file must be either completely flat, or completely expanded (nested). Not partially both.

Please provide your attribution name and optional email address.

What is missing Folder?

The lang/missing/ folder contains files for all languages showing all Localization Strings that are in the Module, but are not covered by that Language. For example, there are 6 strings not covered by Polish language, but since they are simply API Error messages, there is no need.

Contact

Michael Leahy aka TyphonJS is maintaining and adding new features as the main developer for the TyphonJS Quest Log.

We request that you contact MLeahy#4299 for permission to use the name TyphonJS Quest Log in your fan works, self-promotions, and advertisements. Do not use the TyphonJS name or the names of other contributors without permission.

Please feel free to join the following Discord servers:

Acknowledgments

TBA

Support

TBA

License

TyphonJS Quest Log is a module for Foundry VTT by Michael Leahy and is licensed under the MPL v2.0 License. List of contributors in AUTHORS file.

This work is licensed under Foundry Virtual Tabletop EULA - Limited License Agreement for module development from February 17, 2021.