Window Saver X Extension - Continued as X2

[jharp]

Support thread for forge extension. Continuation of Window Saver X Extension.

Available at: https://forge.fantasygrounds.com/shop/items/270/view

Description
Overview

Supported edition of Window Saver X v3.4.0 as Window Saver X2


Window Saver X allows you to create and edit multiple presets of your often-used windows, then deploy them quickly and easily at need.
- If you are used to saving links in stories to open up a bunch of windows when you start a new encounter, you should consider saving those windows as a preset!
- If you have a layout you like your windows in when you're in town, you should consider saving those windows as a preset!



Authors: Continued by Jason Harp from Zack 'Gkjsdll' Winchell's WindowSaverX_v3.4.0. (special credit to James 'lokiare1' Holloway for the original adaptation)


This extension started off as a patch for Window Saver by lokiare1 to add client support, but has since split off into its own extension. I've tested primarily in 5e, but it probably works with most/every ruleset.

Instructions

/wsx clear [name] - Deletes the preset named [name]
/wsx close - Closes all open windows (reopen with /wsx restore)
/wsx help - Displays basic info on the other slash commands in your chat box
/wsx list [page number] - Lists your saved presets
/wsx load [name] - Closes all open windows, then opens windows in the preset [name]
/wsx open [name] - Opens windows in the preset [name] without closing windows
/wsx restore - Reopens all windows closed by the last time you quit the game or loaded a preset
/wsx save [name] - Saves a preset as [name]

GM Only:
/wsx share [name] - Opens windows in the preset for everyone, sharing windows as needed

Known Issues


Some windows aren't properly tracked on client. There's a bug in FG that currently prevents windows created by the client from being tracked until you close & reopen them. This is pretty specific issue that will go away as soon as the bug is fixed.
Reports that a " " or "." in the Chat name causes issues. Still investigating. Workaround is to not use either character.
Does not save position of Tower presently.



Wishlist

Remembering minimized state for windows and images.
A GUI would be nice. The ability to make presets a link, so I can add them to a Story and click to share a bunch of windows/images.
A GUI that supports all of the same functionality as the slash commands. While I love slash commands, I know that there are plenty of people who prefer a GUI. Not sure if GUI would be opened with a button somewhere in the interface or with the slash command /wsx.
Searching through presets rather than listing all of them. Waiting on GUI, maybe no slash command. Maybe /wsx search [query], where you get a list of all presets that start with your query.
Links for Maps which open a set of saved windows without closing windows Waiting on GUI. The idea for this one is that when your party enters a new room with separate notes, an encounter, a loot table, etc... You can open all relevant windows in 1 click in saved locations.
Create presets by drag-and-dropping open windows into GUI Waiting on GUI. This will use the location of the window at the time of drag-and-dropping, which can be updated by re-adding the window to a preset.



Notes

I like to use RTS-style grouping hotkeys, which you can add using hotbars. (e.g. CTRL+F1=/wsx save temp F1=/wsx load temp)

If you load a preset that has no windows in it, all open windows will be closed, which you may or may not find useful.

This extension uses semantic versioning, which means that the way I change the version number is changed as follows (vX.Y.Z):

X Changes when the new version breaks something that the extension did before. There's only planned feature that might lead to this, at the moment.
Y Changes when new functionality is added and nothing is broken by the update. Most version changes will hopefully change this number.
Z Changes when no new functionality is added, bug(s) are fixed, and nothing is broken by the update. If I were perfect, every version would end with ".0"

[jharp]

Recent Version History

Window Saver X2

v1.1.1

Bug: FGU 4.3.0 support for 2E ruleset

v1.1.0

Bug: FGU 4.3.0 support.

v1.0.2

Bug: /wsx close was not working as expected.

v1.0.1

Bug: Opened window could open outside screen width/height. (thanks to md0072 for report)

v1.0.0

Bug: Fixed compatibility with Better Menus extension.


Window Saver X

v3.4.0

Feature: Added /wsx share (thanks to seycyrus for suggestion)

v3.3.0

Feature: Added /wsx open
Bug: Fixed errors in client console.

v3.2.1

Bug: Fixed errors in client chat box

[jharp]

reserved2

[dpezet]

Is anyone else having issues with Windows Saver X2 when using the cloud lobby in FGU? I've been having some issues with it for at least the last week, but I finally had time to troubleshoot it and narrow down how to recreate my issue and it looks like it might be related to the cloud lobby. Originally, I assumed it was an extension conflict (I run about 14 extensions normally), but I was able to recreate my problem in a new campaign with only WSX2 enabled. Here is what I am seeing:

Problem: Windows Saver X2 does not save presets when issuing the "/wsx save <name>" command.
FGU Version: 4.1.10 Ultimate (2021-10-05)
OS: Windows 11 21H2 (22000.194)
Steps to recreate the issue:
1. Launch Fantasy Grounds.
2. Select "Create campaign".
3. Enter "Test Campaign DP" for the name.
4. Select "Dungeons and Dragons (5E)" for the ruleset.
5. Enter "password123" for the password.
6. Enter "GM" for the chat name.
7. Set the server type to "Cloud".
8. Set the server list to "Private".
9. Enable only the "WindowsSaverX2" extension from the Fantasy Grounds Forge.
10. Click "Start".
11. Close the "Campaign Setup" window.
12. Open the combat tracker and the party sheet.
13. Type "/wsx list". It returns "[WSX] You have 0 presets".
14. Type "/wsx save test". It returns "[WSX] Saved 2 windows to 'test'"
15. Type "/wsx list". It returns "[WSX] You have 0 presets".

I've also been able to recreate this by taking a pre-existing campaign that was previously set to "LAN" and switching it to the cloud lobby. Once the bug hits, that's it for WSX. It will no longer save presets even if I flip the campaign back to the LAN server type.

I haven't tested it on a different computer yet, so that is the next thing I'll try. I just wanted to see if anyone else was running into this.

[jharp]

I'll test it out and see if I can find a fix. And thank you for the very nice set of steps. Will likely make my life a lot easier to find a fix.

[dpezet]

I just tried it out on a Mac running 4.1.10 (2021-10-05) and it did not have the issue, so my previous example may be a red herring. I definitely have one campaign that cannot save presets no matter what I try, so I'll keep trying to narrow down the guilty culprit.

[jharp]

If you pm me with a link to the campaign I will debug the broken one. My attempts with those instructions worked fine. Sorry.

[dpezet]

Just in case anyone else runs into this, it turns out the problem was because I had a period in my chat name. Once I removed that, everything started working fine. Extra thanks to @jharp for helping me track that down.

[dpezet]

@jharp is there any chance that WSX could save the position of the dice tower as well? I know it isn't a window per-se, but that thing is always moving around on me. I would love to be able to restore its position. Thanks!

[jharp]

@jharp is there any chance that WSX could save the position of the dice tower as well? I know it isn't a window per-se, but that thing is always moving around on me. I would love to be able to restore its position. Thanks!

I think the original code actually purposely ignores it. I don't think it would be too difficult to fix. I'll let you know.

[dpezet]

Just a heads up, but it looks like the newest version of FGU removed the ability to change your screen name in the game lobby. It looks like it just uses your Fantasy Grounds account username by default now. For players like me that change their screen name for each campaign, it means we lose all of our WSX presets. Not a WSX issue, but you'll probably see reports of people losing their presets.

[dpezet]

Actually, it might just affect the GM. I looked in the db.xml file and my new presets are now under "GM" instead of "dpezet". I was able to copy my presets from my old screen name manually.

[jaharmi]

Ah, I lost my presets this week and was wondering why. ��

[welkin42]

I've been having an issue for many months since I first started using Windows Saver X2 and may have just assumed it was associated with a bug mentioned in the first post, but I'm not sure if that's the case as I just tested with Windows Saver X and did not have the issue. It appears that Windows Saver X2 is not saving windows/positions on session end. If I'm in a campaign where I was previously using Windows Saver X and I run the restore command using Windows Saver X2 it will open the last session saved by Windows Saver X, if I'm in a campaign that I've only used Windows Saver X2 and use the restore command it says there are 0 windows. I just double checked with a new campaign that the only extension used was Windows Saver X2 and after I loaded it using Windows Saver X, and later went in with WSX2 it opened the info from WSX but wouldn't create it's own information.

[jharp]

My FG Forge account is in restricted mode at the moment. I expect it will be remedied soon but in the meantime I'm not certain what will occur to your ability to use this module. Let me know if it doesn't work anymore.

Jason

[Direswift]

I am using the Old School Essentials ruleset and a few of the rolls from the character sheet (All Saves and Turn Undead for Cleric) cause the following error:

[ERROR] Script execution error: [string "RulesetWizardDiceRoller.lau"]:41: attempt to call field 'getActor' (a nil value)

This extension is a godsend otherwise for one click loading of my layout and forcing a layout for new players that aren't familiar with Fantasy Grounds but unfortunately the error is preventing me from using it currently.

[jharp]

I have checked the box in Ruleset Wizard that excludes the built in Roller.lua so this should go away once the patch is approved.

Jason

[Direswift]

Perfect! Updated and works as expected. Thanks!

[jharp]

Wonderful.

[0m0n]

Looks like this extension is broken with the latest FGU update. Errors on load and when using commands
54754

[Taralas]

Can confirm.

[jharp]

I'll take a look and update forge.

[jharp]

V1.1.0 fixes this and is awaiting forge approval.
Jason

[jharp]

Forge has 4.3.0 compatible version now. v1.1.0

[0m0n]

I can confirm it is working for me now. Thanks for your quick action.

[scoot138]

using 2E ruleset
Cannot open
Character Sheet
Modifiers
Effects

When adding new entries to anything that allows entries to be created, notes for example, get the following error.
[10/20/2022 10:41:44 AM] [ERROR] Script execution error: [string "CoreRPG:..n/scripts/campaign_button_new.lua"]:28: attempt to index local 'w' (a nil value)

This is with only WindowSaverX2 loaded and no other extensions with a fresh campaign

Scoot

[jharp]

Confirmed. Trying the new API to fix this.

Edit: Fixed in v1.1.1 - awaiting forge approval.

Jason

[jharp]

v1.1.1 released and fixes 2E issues.

[Noneya]

Sorry, bit confused. I have Window Saver X 3.4.0. I'm having these errors. I feel like i have the latest version but i'm not sure.

What is v1.1.1?

[jharp]

Version 3.4.0 of Window Saver X is the old extension. It no longer gets updates so it has been broke for a bit. You should get rid of it in your extensions folder and then go to Forge and get the new Window Saver X2 (v1.1.1 is the latest).

Then once enabled you should not see any v 3.4.0 printout only v1.1.1

Forge entry is : https://forge.fantasygrounds.com/shop/items/270/view

Jason

[Noneya]

Thanks for replying. That's what I had thought, I guess i'm just new here/there, but I don't see a download button there. It just says "Owned" in top right. I don't see a way to get 1.1.1 but I'm probably just missing something?

[jharp]

Ok so if it says owned then your account has it. You just need to do an update when you launch FG (Click the Check For Updates button on the launcher). Likely you already have.

After the update you just select the Extension "WindowSaverX2" to add to your campaign.

Jason

[JohnD]

Thanks for replying. That's what I had thought, I guess i'm just new here/there, but I don't see a download button there. It just says "Owned" in top right. I don't see a way to get 1.1.1 but I'm probably just missing something?

You probably haven't unselected the original extension and then selected the new version.

[Noneya]

I am sorry, I don't see where you mean to "unselect it". In the forge? In FG? Where is this?

I have updated FG since starting this, and it doesn't seem to do anything different with the plugin or error.

[Noneya]

Hmm. ok. I think I have multiple install folders for some reason and theres' confusion what's being read from where. I think I have the plugin 1.1.1 loading now, but since the latest update of FG, I'm still getting load errors and my maps are blank, so very confused on what I've allowed to happen here. Never been a problem, but something is amiss.

[jharp]

As always I will need some details (ie the error message). Given this extension has nothing to do with maps I'm thinking you have other issues at hand but I'll see what I can do once you give me the error.
Jason

[Noneya]

As always I will need some details (ie the error message). Given this extension has nothing to do with maps I'm thinking you have other issues at hand but I'll see what I can do once you give me the error.
Jason

Yeah, so with all of your help i think i have the plugin working, now it's just a matter of finding out why some of my maps aren't showing, and the errors i'm getting. I apparently have multiple locations for campaigns / extensions / data, for whatever reason. Need to find out what's what and not lose my campaigns. When I know more I'll post. Thanks for the help so far.

[seycyrus]

I am getting a bunch of errors when I use this extension to load in saved windows, since the FGU 4.4 update.

The windows DO load, but I'm getting a bunch of errors for each window.

I'm using the Gurps ruleset. Anyone else having problems (with any ruleset)?

[Ulric]

I am also getting errors loading saved windows in Starfinder.

[Noneya]

Yeah, so with all of your help i think i have the plugin working, now it's just a matter of finding out why some of my maps aren't showing, and the errors i'm getting. I apparently have multiple locations for campaigns / extensions / data, for whatever reason. Need to find out what's what and not lose my campaigns. When I know more I'll post. Thanks for the help so far.

I thought I responded since this. There was apparently a problem with maps from certain modules (phandelver and SKT) after an FG update around that time, found instructions for reloading mods (I'd recount but don't recall now specifically) but once i did that all was well. Sorry for the confusion.

Also streamlined my installs, which may have helped.

[jaharmi]

I’ve been using this extension (in various forms, now the Forge version) for some time. It has really helped me manage the many windows on the GM side. Thank you!

I re-read the description and (re-?)discovered the `wsx share` command. Can I get an example of how a GM could use this to help set up important windows for players, but a) without showing GM-specific windows and b) without messing up the players’ own windows/view? Is the command more like the `wsx open` command than `wax load`? The best I can think of is to do something at the start of the session, using a GM preset with minimal player-facing windows, and then later using the GM’s normal preset.

Thanks!

[Zacchaeus]

I've never used this extension but reading the description it says 'sharing windows as needed'. That, to me, means that only windows that are supposed to be shared (basically the Combat Tracker, Party sheet and maybe a map - I can't think of any others). with your players. I'd use that with caution since not every player will have or want the same set up as you Or even have the same size monitor). So foisting your idea of a good way of displaying things on your players may not be terribly popular.