2.6.1

[2.6.1] - 2024-05-12

☮️ Peace in the world, or the world in pieces. 🕊️

Fixed

• #148: An error that occured if the Dramtic Task Planner was executed without the Challenge Tracker module enabled.

2.6.0

[2.6.0] - 2024-05-11

☮️ Peace in the world, or the world in pieces. 🕊️

Added

• Added a hook ('swimShapeChanged') that is called after the shape changer completed the shape changing process. It passes the new token in order to work with that further in code.
• Dramatic Task Planner Macro. Please read the Wiki on it, it has a couple features that are explained there.
• Added swim.revert_shape_change(token) to revert the passed token back to its original form.
• Added automatic power backlash execution for the BRSW support.
• • Currently only automates regular backlash.
• • Dynamic Backlash can be set in the SWIM settings but it will only roll on the table (make sure to import it into your world and set the name in the SWIM settings).
• • This can also be turned off independently of th BRSW support.
• • The regular backlash is fully automated and will also revert shape change forms, dismiss summoned creatures and terminate all powers if they are set with the Power Effect Builder.
• • It will also apply Fatigue (or Inc.) as per the base rules.

Changed

• When removing maintained power, gathering effects is now in a try statement so that the function continues if an error occurs (i.e. when the token changed or doesn't exist anymore.)

Fixed

• Fixed chase deck table not resetting results when resetting a chase scene.
• Shape Changer now properly handles wild card images for shape change presets. The Shape Changer will get a random token image from all possible token images of the SC preset and use that. This does not prevent the user from setting up the prototype actor without wildcard images.

Known issues

• The Dramatic Task Planner currently doesn't put journal links in the dialogue and chat message, the reason for this is unknown, help would be highly appreciated.

2.5.0

[2.5.0] - 2024-03-24

☮️ Peace in the world, or the world in pieces. 🕊️

Added

• New SWIM config for actors allowing the user to set up a custom mirror self token image. If using the Mighty Summoner, this image will be used for the mirrored self. If empty it will use the summoners token instead. This setting does accept wild card images.
• Added shaken link to official module link list.

Changed

• Merged both Unshake functions into a single one. This should make it a lot easier to maintain it in the future and (hopefully) not affect the user in any way.
• Mark dead will now apply defeated to NPCs and incapacitated to PCs.
• Moved away from the deprecated SUCC API in favour of the new one (thanks @ddbrown30).
• [BREAKING] Changed the naming of the deflection active effect created by the Effect Builder from "Deflection (range)" to "Deflection (ranged)". This will mean currently active effects will not be recognised by BRSW rolls anymore and need to be adjusted.

Removed

• Removed the hold functionality in SWIM (or rather disabled it for the moment) as it is broken in SWADE 3.3.6+ and would need a major rework.

Fixed

• Tester macro failing to create a support effect if a combat is active.
• Added a failsafe to the Effect Builder in the unlikely case of a target not having any skills.

Known issues

• The actor created as the mirror will only have the proper image if it is not a wild card image path. If it is, the summoners image will be used.
• Deflection malus is added twice in some cases when using it along with BRSW. This is currently being worked on. Disable the action in BRSW as a fix for now.

2.4.0

[2.4.0] - 2024-01-20

☮️ Peace in the world, or the world in pieces. 🕊️

Added

• Tester macro now remembers the best roll and uses that instead of the last roll.
• Encounter table setup directly from the travel calculator macro.
• Mighty Summoner now respects the summoning tokens disposition and uses it for the summoned token.
• Function to prevent the conviction expiration dialogue from the core system that is added by SUCC.
• Added a failsafe to the ammo management that prevents code failing on a RoF higher than 6.
• Added SUCC 2.3.0 support for the effect builder which means it now uses the new SUCC api and also properly passes the effect duration.
• Chase background images that serve as an example and make the scene be visible easier. Users are encouraged to setup their own however.
• Added a free reroll on failed (but not crit failed) rolls to recover from being shaken if the Old Ways Oath hindrance (Deadlands) is found on the actor. (This is an odd hindrance that allows a free reroll on spirit for some reason.)

Fixed

• Fixed a critical bug in the Tester macro where on some test rolls the support roll function was called.
• Fixed a critical bug in the Travel Calculator macro that prevented its function if no custom options json was given.
• Fixed some errors in translation strings.
• Fixed a critical error that made the ammo management update an items quantity or shots with a string rather than a number resulting in data loss.
• Fixed a bug that prevented passing the duration of effects in the effect builder to SUCC resulting in faulty duration.

2.3.0

[2.3.0] - 2023-11-11

☮️ Peace in the world, or the world in pieces. 🕊️

Added

• Several new sfx to be used in the Travel Calculator (see below).

Changed

• [BREAKING] Changed BRSW ammo management integration to using the new br_card instead of message. As a result you'll have to delete the old "SWIM: Ammo usage" macro and import the new one from the SWIM macro compendium in the "BR2 Macros" folder. Or replace your existing macros (entire!) code with swim.br2_ammo_management(br_card, actor, item).
• Big Travel calculator refactor to simplify the code a bit and allow for more options and customisation.
• • Added a setting to input a JSON structure that can define custom created means of travel.
• • Added SFX support to Travel Calculator.
• • Added Stealth Mode to Travel Calculator that allows the GM to plan a journey ahead of time without notifying the players or just to silently check the required time (won't play SFX and won't show image).
• • New Constant containing all the default means of travel.
• • Documentation on the new changes and an example JSON for adding your own means of travel.

Fixed

• Repeating migration warnings.
• Low Light vision providing vision even in pitch darkness using the token vision macro.
• Fixed a bug in the Tester macro where a support roll of less than 4 still showed a +1 support in the chat card.

2.2.0

[2.2.0] - 2023-10-18

☮️ Peace in the world, or the world in pieces. 🕊️

Added

• Tester Macro to test and support enemies and allies. Please read its documentation here to learn about its current limitations.
• Mighty Summoner now adds +1 damage to all weapons that use the fighting skill if the Fervor edge is found on the summoner.

Fixed

• Fixed a bug in the unstun macro, that prevented it from finding the Elan edge in other languages.
• Fixed a bug in the Travel Calculator that caused it to break if no tables for random encounters were present.
• Fixed Ammo Management non-functional due to BRSW update.
• Fixed false variable declaration in lang file.

2.1.0

[2.1.0] - 2023-07-05

Added

• Travel Calculator is now able to generate encounters.
• • If checked (requires random tables such as those provided by SWIM) it draws a card for each day of travel.
• • SWIM uses its own card deck API introduced in 2.0.0. Yes, it is a card deck and it is fair.
• • Cards with values of 10 or lower are ignored.
• • Face cards and higher trigger an encounter drawn from the tables depending on suit (as per the core rules pg. 144).
• • On a Joker, two more cards are drawn and the results are combined (as per the core rules pg. 144).
• • If a Joker is drawn as part of a card draw triggered from a Joker, the card is redrawn and the Joker is discarded without effect.
• • If encounters are calculated, there won't be a dialogue showing the results, instead a JournalEntry will be created with all the data.
• • The JournalEntry is carefully crafted and created in a folder that is created if not present yet.
• • The image gets shown to all as usual, the JournalEntry is shown to the GM.
• Official modules file in which the div classes and links for the official modules are stored.
• • You can contribute to that list by adding the official modules of your language to the bottom of the list.
• • If you do so please create a PR with the updated file.
• • Also please sort the modules by language, all official modules of a language should be after each other.
• • Please note that SWIM checks from the bottom up, so you'll have to put specialised modules lower and general ones towards the beginning, that's why SWADE Core and SWPF appear first since these are the ones carrying all the basic rules.
• New API function that finds a journal link in the Official modules file.
• New API function that finds a compendium key in the Official modules file.
• Some support for the Brazilian Portuguese core rules module (mclemente).
• Deviation macro localised.
• New art for the deviation clock.
• Size & Scale Calculator localised.
• New localisation strings.

Changed

• The API function to get the official div class of modules was rewritten to be less hard coded and to use the Official modules files contents instead.

Fixed

• Calculation bug in travel calulator that sometimes caused faulty results.
• Broken Journal link in Deviation and Scale Calculator.
• Some Weblate issues and manually merged translations (thanks at everyone contributing to the translations).

2.0.1

[2.0.1] - 2023-07-03

Fixed

• Fixed a bug in the Mighty Summoner where it always tried to find the Special Abilities, even with no compendium provided, thus causing an error.
• Fixed a bug that caused an error message if the raise calculator button was turned off.
• Fixed error messages that occured if BRSW support was turned on but with the module itself not active in the world.

2.0.0

[2.0.0] - 2023-07-02

Added

• The Power Effect Builder now adds the powers description to the active effect if a power item is found on the actor. This currently only works for power effects not handled by SUCC (so every AE except Boost, Lower, Protection and Smite).
• Migration to change all AE data for ammunition to use the new 'name' property instead of 'label'.
• Mighty Summoner now is aware of the Edges "Summoner" and "Druid" (Fantasy Companion) and adjusts the duration accordingly (duration in minutes for Summoner, one hour for Druid). It uses a base duration of 5 however so there might be problems with powers of a different duration. If the "Concentration" Edge is found the duration is doubled after respecting the duration increase from "Druid" or "Summoner". The duration can still be changed manually.
• New Translation strings.
• Keybinding option for the Raise Calculator (mclemente)
• SWIM compendiums get sorted into its own folder if not manually sorted (mclemente)
• Added a setting to allow the selection of a compendium containing special abilities (javierriveracastro)
• Mighty Summoner is now capable of creating a 'Mirror Self'. For that the macros dialogue received a new entry in the selector which is always available and always the last option. It needs to resort to some trickery and creates a new actor in the [SWIM] Summon Creature folder structure which is deleted after the mirror is dismissed.
• The 'Mirror Self' token image can be mirrored horizontally, set up in the macro options tab in the SWIM settings.
• Falling damage calculator fully localised.
• New Setting that allows the user to configure the BRSW integration for SWIMs Ammo Management. It can be set to either 'full' (works as before with SFX and reducing ammo), 'sfx only' (only plays SFX but won't reduce any ammo) or 'disabled' (fully disables Ammo Management and SFX and won't show the red button on the BRSW chat card). This allows you - for the first time - to enjoy the sound effects without having to worry about ammunition.
• When soaking wounds, the function now will keep track of your best result and will use that number for the rest of the procedure (rerolling, applying wounds, etc.) until you either roll an even better result or a critical failure (in which case the original amount of wounds is used in the apply wounds dialogue (you can still change it there though)).
• A new travel calculator macro that takes some inputs and calculates the time needed to travel the given distance with the given means of travel. It'll then show a flavour image and the results of the calculation.
• A bunch of flavour images for travelling. They are used in the new travel calculator to create some immersion.
• SWIMs own deck of cards (poker deck with jokers left in) with corresponding functions to draw and shuffle. These are considered helper functions and won't appear anywhere in the module but can be called using swim.draw_cards(numberOfCards, playSound) (numberOfCards is the amount you want to draw, playSound is a boolean) and swim.shuffle_deck(playSound, notification) (both variables are a boolean). Why? It was easier to write from scratch than dealing with the Foundry card API.
• Four Roll Tables with travel encounters that may or may not fit the setting you're playing. Their main purpose is to be used in the future version of the Travel Calculator.

Changed

• Migrated all active effect creations to use the 'name' property instead of 'label' as this was changed in Foundry v11.
• Ammo Management now respects the reload type 'single reload' and defaults to one bullet relaod if the weapon is set up like that. As a result, the setting in SWIM that sets the checkbox in the ammo management dialogue was deprecated.
• The Raise Calculator button in the scene controls can now be turned off (mclemente)
• Most console logs will now appear with SWIM | in front of them in order to make their source easier to identify for the user.

Fixed

• Effect Builder and Fear Table macros being partially broken due to changes in SUCC.
• Fixed a bug that caused some summoned creatures from the Mighty Summoner potentially being actor linked.
• BRSW unable to roll damage for a deleted consumable weapon. This was supposed to be fixed but isn't, so reverted this back to never delete a consumable weapon if it gets to quantity zero.
• Fixed a bug in the falling damage calculator that resulted in it not finding the toughness of a tokens actor.
• Fixed some other bugs when dismissing summoned tokens.
• Fixed deprecation warning resulting from using effect.flags.core.statusId.
• Fixed a bug that opened the token vision macro if the macro was used to create the effect.
• Fixed a bug in the Mark Dead macro that prevented the removal of Incapacitation. It now toggles on/off again.
• Fixed adding system.stats.speed.value to Shaken if SWD rules are active which required changes in SUCC.

Removed

• Some translation strings no longer needed.
• Default value for campfire as leaving that in was an oversight. SWIM does not come with a texture for campfires yet, I hiighly recommend the animated one from JB2A though.
• Old compendium .db-files no longer used in v11.
• Compendium Folders is no longer a dependancy.

1.5.0

[1.5.0] - 2023-05-28

☮️ Peace in the world, or the world in pieces. 🕊️

Added

• New translation strings, Radiation Centre is now fully localised.
• Support for the Soak Bonus modifier in SWADE. The Soak macro tries to exclude edges which are already set up with an Active Effect but that's not a fuzzy search so it will only exclude its own Edge findings if the edges corresponding AE is named exactly like the edge itself. Otherwise it will add the bonus twice. There is no real way around it as it could cause false matchings if I were to introduce a fuzzy search.

Changed

• Mighty Summoner will now summon tokens without actor link to prevent changes to the original actor. This means GMs don't have to unlink the prototype tokens manually anymore.
• Overhauled the Radiation Centre Macro:
• • Radiation Centre doesn't add a condition for Fatigue from radiation any longer (see below). This deprecation was needed as the new SUCC version doesn't currently have API support to add conditions. This makes the macro work closer to RAW however.
• • Radiation Centre does however add an Active Effect if the actor becomes Incapacitated from radiation: As in core this AE represents a chronic disease. A chat message will be created in this case.

Fixed

• Bug in the Radiation Centre which made it non-functional for NPCs.
• Bugs in Ammo Management resulting from the overhaul in SWADE.

Deprecated

• The Irradiated condition was deprecated to suit the new SUCC version better.
• Combat setup button as the function behind it is a little buggy and due for an overhaul. Let me know if anyone ever used it, otherwise it won't be a priority.