Releases: frondeus/fvtt-syrin-control
0.4.0-alpha-3: first-class support for Playlists
This is a community-made, unofficial project
This is a pre-release version
Please keep in mind that I'm still working on it. It is not polished as I would like it to be.
How to install it
Manually put the manifest URL to the Foundry:
https://github.com/frondeus/fvtt-syrin-control/releases/download/0.4.0-alpha-3/module.json
Features
First-class support for Playlists and Playlists Sounds
This is the most significant change I have made. With this release, I made an initial integration with native Playlists with Syrinscape.
It means that while macros still are available and can be pretty valuable, now you have access to many features that should work seamlessly.
The importer dialog (where you could search for soundsets and bulk-create macros) now has the additional action of importing playlists.
The Soundset is represented by Playlist, while PlaylistSound represents the Mood. Keep in mind this is not the final integration. I am not using the audio internals of the Foundry, meaning there still is a separate audio context and separate volume slider.
Show currently playing mood even if it's not imported
If you are controlling moods via macros or via the original syrinscape control panel, SyrinControl will detect that, and if the mood does not appear on any playlist, it will show a separate entry with an option to import the soundset to Foundry directly.
Breaking changes
Removed link between Scene and Mood
Since there is playlist support, scene configuration no longer contains an option to set the mood. Instead, I recommend importing the selected mood and setting it with the native ambiance setting. It just works :)
All volume controls are now under Global Volume Controls
Work in progress
- I'm currently working on a couple of fixes for overall stability, as well as a way to show/import not only the moods but also elements like SFX, music, etc. Those are a bit tricky since one element can be reused between different moods. I am working on intuitive UX.
0.4.0-alpha-2: embedded audio!
This is a community-made, unofficial project
This is a pre-release version
Please keep in mind that I'm still working on it. It is not polished as I would like it to be.
How to install it
Manually put the manifest URL to the Foundry:
https://github.com/frondeus/fvtt-syrin-control/releases/download/0.4.0-alpha-2-2/module.json
Features
- Embedded Syrinscape Online Player
- Volume control - fixes #8
- Detection when the mood is changed outside of the Foundry
Embedded Syrinscape Online Player
An early Christmas gift - Syrinscape Team recently released the Syrinscape Online Web player. They also released JavaScript headless player that developers like me can use in projects like SyrinControl.
What does it mean?
You do not need Syrinscape Player opened to hear sweet moods! SyrinControl will play the audio (both moods and one-shots) directly in the browser tab (alongside the FoundryVTT native audio)!
Currently, this means that SyrinControl creates another context, so you cannot for example, control Syrinscape volume with the same slider as the user-provided audio files in the playlist tab, but there is a remedy for that as well :)
Volume control
This release allows a GM to control the global volume of moods and one-shots (separately, with two sliders)!
Additionally, each player (and GM) can adjust their local volume to their needs.
Detection when the mood is changed outside of the Foundry
Up to this release, the SyrinControl knew only about the currently playing mood when the module commanded it. It meant that if you changed the mood from the original Syrinscape app or from the Syrinscape Online Master panel, then SyrinControl wouldn't know about the change.
Thanks to the new headless player, this is no longer an issue!
SyrinControl will notify the GM when the mood changes, no matter who caused the change.
Breaking changes
Removed Playlist feature
I've noticed that the current macros solution is superior to the playlist feature - after all, it allows the GM to import needed moods and save them in the folder. If GM wants, they can then store mood macros in the collection, keeping the world tidy.
Therefore I decided to remove the previous playlist functionality. A GM can still see what is played and access the one-shots dialog.
0.4.0-alpha-2: embedded audio!
- yanked - I published the wrong branch :)
Please see https://github.com/frondeus/fvtt-syrin-control/releases/tag/0.4.0-alpha-2-2
0.4.0-alpha-2
- yanked, please see https://github.com/frondeus/fvtt-syrin-control/releases/tag/0.4.0-alpha-2-2
I simply made an error during releasing, sorry for that!
0.4.0-alpha-1: Mood macros!
This is a pre-release version
Please keep in mind that I'm still working on this version, which is not polished as I would like it to be.
How to install it
Manually put the manifest URL to the foundry:
https://github.com/frondeus/fvtt-syrin-control/releases/download/0.4.0-alpha-1/module.json
Features
- New Syrinscape Online soundsets viewer.
- Possibility to create mood macros. Fixing #36 and #37
- Search for soundsets in the new viewer. Fixing #27
New Syrinscape Online viewer
In Audio Playlist tab under the dropdowns there is new button which opens a new dialog.
In this dialog you can see and search for all soundsets, select them, see moods assigned to the soundset and finally - play moods, create macros for moods or open elements dialog for one-shots.
It also allows to bulk-create macros by selecting multiple moods and/or whole soundsets. It creates macros in folders so everything should be pretty tidy.
Breaking changes
None, this version should work just like the previous ones. It only adds a new dialog
Internal improvements
I refactored a good portion of the codebase to ensure that #35 won't occur again.
0.3.1
Fixes #35
There was a nasty bug that occurred only on Chrome on macOS. Since I don't have an Apple device, I couldn't reproduce the issue.
Thankfully @YenBenGrey decided to help me and tested nine different pre-release versions of SyrinControl so that I could understand the root cause.
Now it should be fixed.
I added a new option in the module configuration, which enables detailed traces for debugging purposes. If you experience any issues, please enable this new option before making a new issue.
A glimpse of the future
Just a notification - I started working again on this project to enable macros for playing moods!
During my long campaign of Masks of Nyarlathotep, I noticed that many scenes have multiple moods, for example, one for a day, one for a night, one when players enter a secret basement, etc.
With macros, it would be possible to integrate Syrinscape with Monks Active Tiles!
Now, this might completely change how we interact with SyrinControl since it might be just easier to generate macro per each mood and use macro folders/macro compendia (with optional support for compendia folders) than using the "playlist" feature of SyrinControl.
Especially that macros are easily searchable by Quick Insert, and in each compendium, you have a search box.
This means a new dialog and overall overhaul of the whole SyrinControl UI.
As you can see, the new dialog has a search mechanism (only for soundset names for now, since the module simply doesn't know all moods user has access to and loads them on demand).
Also, I'm considering replacing integration between Scene-Mood (activating a scene activates the mood) with simpler yet more robust integration of Scene-Macro. Since each mood could be played from a macro that gives extra flexibility to the user, including excellent integration like "check in AboutTime/SimpleCalendar what time it is and play daylight or nighttime mood automatically".
However, that seems to be out of the scope of SyrinControl; therefore, I'm thinking about creating a new module focused only on that aspect and leaving SyrinControl only with generating the macros and playing sounds on demand. Those two modules (SyrinControl and the new Scene-Macro integration module) could be, however, combined together to recreate the same behavior you know today.
As you can see and imagine, this is an exciting future in front of us.
Call for support
As you noticed, I wasn't the best maintainer of this module. Usually, I have very little time to do anything, and I start working on a project only when I personally need something new (like the mood macros). Sorry for that.
That being said, I would appreciate any help in the form of PRs. I try to keep the codebase clean, and I would love to answer any technical questions or mentor. And I also would like to say thank you to all people who spend their time trying to debug my module and make it better, or at least leave suggestions for what could be awesome or done better. I appreciate you all.
Contributors
Assets 4
0.3.1-alpha1 v9
Full Changelog: 0.3.1-alpha1-8...0.3.1-alpha1-9
0.3.1-alpha1 v8
Full Changelog: 0.3.1-alpha1-7...0.3.1-alpha1-8
0.3.1-alpha1 v7
0.3.1-alpha1-7 Fix tsconfig
0.3.1-alpha1 v6
Full Changelog: 0.3.1-alpha1-5...0.3.1-alpha1-6