samfundev / ktane-mods

All the mods that I've released for KTANE.

KTANE Mods

This is a repository for all the mods that I've released for KTANE. All KTANE mods I've worked on can be found on the steam workshop. Module manuals are also available on the Repository of Manual Pages.

Credits

Attributions for things used in these mods:

"Success 04" by rhodesmas, used under CC BY / Made slightly quieter, used in Minesweeper.

ktane-mods's Issues

Broken Buttons: prioritise third row over second for Twitch Plays.

There have been mistakes made with this module on Twitch Plays where the third row had a T-word which was also duplicated in the second row. Entering !# press "TWO" pressed the one on the second row, which is wrong. Is it worth changing this?

Update Tweaks documentation

The Tweaks documentation is out of date due to the many recent setting changes.

Tweaks: Allow TweaksEditorSettings to restrict the type of array items

Most of the time, when a mod settings file includes an array, it expects the elements of the array to be of a specific type. I propose that a field in TweaksEditorSettings be added which will allow the mod to specify the expected type of array items, so that the Mod Settings UI automatically selects that type rather than asking the user to choose a type.

Tweaks: Add RemoveIncompatibleMods feature

Unsubscribes from mods that are marked as problematic or unplayable.

Tweaks: Add note slots like TP has

Note slots would help people with accessing their notes easier then alt tabbing to notepad all the time. Having notes slots should not remove scores from leaderboards.

Tweaks - Add Turn The Keys fix

Currently it is possible for Turn The Keys to solve when only one of each type of module has been solved despite the manual saying otherwise. This should be fixed via Tweaks.

Minesweeper throws an exception if anything is pressed before the lights come on

https://ktane.timwi.de/More/Logfile%20Analyzer.html#file=ac5dcf90d81c5051f4b14e496fae009784a382a9;bomb=8U2VP6

Incompatibility with separate Harmony mod

Tweaks became incompatible with the separate Harmony mod which is causing a lot of problems for users.
Figuring out why the Harmony mod isn't being automatically unsubscribed would also fix this.

Support just removing obsolete mods

If a mod has no replacement, Tweaks should still be able to remove it.

Tweaks: "Disable Advantegous Features" option behaves strangely

For this report I'm linking screen recording to show what is going on: https://www.youtube.com/watch?v=-L-_b17Mn44

At 0:05 you can see selected options, notice that "Bomb HUD", Mode "Time" and "Show Edgework" is selected
At 0:14-0:22 I'm showing what mods are installed and enabled
0:25 Selected first bomb

0:30 As you can see, game is showing me bomb HUD even if I had option to disable it on Missions

I was expecting that this information would be hidden from me

0:42 Another strange thing, as you can see I got time bonus and you can clearly see that timer is red (If I remember time mode changes it to orange)
1:11 Here I decided to select option On to disable on everything but as you can see later (1:23) bomb HUD is still displayed
1:39 Disabling HUD separately and on next bomb it's not appearing.

I remember that I once enabled Bomb HUD and went to the mission I saw red text that I have advantages and it won't be submitted into leaderboard. Selecting this option disabled advantegous feature but for some reason it's not doing it anymore. I've tried reinstalling mods and clearing Modsettings folder but bug still persist.

I have created copy of output_log.txt so if it is required for bug hunting I can upload it

Tweaks - Seeds not consistently generating bomb

I'm trying to get a replicable bomb for an experiment, and the Tweaks mods looked like an easy way to do it.

Based on the doc, two players on different computers but with the same settings / seed should be able to get the same bomb. However I'm not managing to get two identical bombs on my computer (osx); I manage to get identical bombs when hitting retry (despite the color of the bomb case changing) but not when going back to the home menu and reloading the bomb.

ex2.mov

The contents of the TweakSettings.json file are as follows (I tried different positive seeds, it did not affect the results):
(I also changed the ModeSettings.json file and configurated the BombCreator from within the game)

{
  "FadeTime": 0.0,
  "InstantSkip": true,
  "ManageHarmonyMods": false,
  "SkipGameplayDelay": true,
  "BetterCasePicker": false,
  "EnableModsOnlyKey": false,
  "DemandBasedModLoading": false,
  "DemandBasedModsExcludeList": [],
  "DemandModLimit": -1,
  "ReplaceObsoleteMods": true,
  "SubscribeToNewMods": false,
  "BombHUD": "Off",
  "ShowEdgework": false,
  "DisableAdvantageous": "Off",
  "ShowTips": false,
  "HideTOC": [],
  "Mode": "Zen",
  "MissionSeed": 1,
  "CaseGenerator": true,
  "ModuleTweaks": true,
  "CaseColors": [],
  "Holdables": {
    "FreeplayDevice": false,
    "BombBinder": true,
    "ModManager": false,
    "DossierMenu": true,
    "BombCreator": true
  },
  "LocalMods": [
  ],
  "PinnedSettings": []
}

Can you see something that I configured wrong?
Thank you!

Localization Update

samfundev/KtaneTwitchPlays#359
I'm posting this here so we have an idea of what things we'll need to deal with once the localization update is pushed to the main branch.

A new feature was (relatively) recently added to Tweaks, which allows the Briefcase to change what word is being shown. Due to the way it works, it always overrides the given text with "Free Play"

I will soon be testing the localization update, and if I notice anything else off in Tweaks, I'll update this post to reflect it.

Tweaks: Remove unnecessary Newtonsoft.Json.dll files

Newtonsoft.Json.dll is already included in the game, so it doesn't need to be included with every mod. Removing them could save a lot of space on disk.

Tweaks: Option to increase/decrease numbered string values in the app

Tweaks: Error when loading mods offline

When I try to enable mods while not connected to the internet, something you can do normally. If the Tweaks mod is enabled the game freezes with this error message:

[Unity] Exception: NullReferenceException: Object reference not set to an instance of an object 
at: DemandBasedLoading+<GetModules>d__20.MoveNext ()
UnityEngine.SetupCoroutine.InvokeMoveNext (IEnumerator enumerator, IntPtr returnValueAddress)

EDIT: As you might expect from the error message this only occurs with demand based mod loading on

Add TP's post game statistics

From ryaninator81#6683: Can we have a option in Tweaks that causes this to show up outside of tp and log the points:

Tweaks: Fix custom mission names and descriptions not getting updated

https://discord.com/channels/581624697976913950/581624697976913952/1139354788035829781

Tweaks: Mod Selector settings page may break if a file doesn't contain expected keys.

When attempting to show a settings page for a file that has associated TweaksEditorSettings data, if the file doesn't contain all of the keys that are listed there, the settings page becomes blank and makes the Mod Selector tablet unresponsive.

KeyNotFoundException: The given key was not present in the dictionary.
  at System.Collections.Generic.Dictionary`2[System.String,System.Object].get_Item (System.String key) [0x00000] in <filename unknown>:0 
  at SettingsPage.ShowSettings (.ModSettingsInfo info) [0x00000] in <filename unknown>:0 
  at SettingsPage+<>c__DisplayClass38_0.<ShowMainMenu>b__0 (System.Object _) [0x00000] in <filename unknown>:0 
  at SettingsPage+<>c__DisplayClass45_0.<MakeListingObject>b__0 () [0x00000] in <filename unknown>:0 
  at ModSelectable.ProxyOnInteract () [0x00000] in <filename unknown>:0 
  at Selectable.HandleInteract () [0x00000] in <filename unknown>:0 
  at SelectableManager.HandleInteract () [0x00000] in <filename unknown>:0 
  at MouseControls.Interact () [0x00000] in <filename unknown>:0 
  at MouseControls.Update () [0x00000] in <filename unknown>:0 

Audio fixes for other modules

Some modules, such as Pow, use audio sources that cannot be controlled by the game's volume controls. I'm pretty sure it's possible to hook into the game such that the volume controls impact these sounds, but a lot of modules don't do that. I believe this should be a feature provided by tweaks.

Fix Demand-Based Mod Loading

Yes, I am bestga.

I decided to enable the Demand-Based Mod Loading setting and it doesn't work, the mods just load the same as normal.

Here are the settings I'm using:
{ "FadeTime": 1.0, "InstantSkip": true, "SkipGameplayDelay": false, "BetterCasePicker": false, "EnableModsOnlyKey": false, "DemandBasedModLoading": true, "DemandBasedModsExcludeList": [], "DemandModLimit": -1, "FixFER": false, "BombHUD": false, "ShowEdgework": true, "DisableAdvantageous": true, "ShowTips": true, "HideTOC": [], "Mode": "Zen", "MissionSeed": -1, "CaseGenerator": true, "ModuleTweaks": true, "CaseColors": [ "random" ], "Holdables": { "FreeplayDevice": true, "BombBinder": true, "ModManager": true, "DossierMenu": true, "BombCreator": true, "ModSelectorTablet": true }, "PinnedSettings": [] }

Minor Timestamp request

I was curious if Tweaks could add a date timestamp to bomb logs that gives you the date and time that a bomb starts in UTC. And if possible, what time is being shown on the alarm clock in game.

I think that having the time be marked down in the log can make it easier for people to find when logs are uploaded and what timestamps issues might take place in TP streams if for whatever reason a vod or clip isn't provided with the log.

Timestamps might be useful for exceptions as well, though I'm unsure if there's anything you can do about that, or if that's even applicable to this mod.