samfundev / ktanetwitchplays

A mod that allows Twitch chat to solve bombs in KTANE.

Twitch Plays: Keep Talking and Nobody Explodes

This mod adds Twitch Chat direct control into Keep Talking and Nobody Explodes, very much inspired by the original Twitch Plays Pokémon channel.

Latest Build

If you want to install the mod, you can always get the latest build from here.

Building the Mod

If you want to build the mod yourself you can follow the instructions found here.

Wiki

There is a wiki for this project, which covers all of the steps of how to setup TP:KTaNE, goes through all of the commands available to Twitch Chat and any other information you might need to know.

To-do List

We track enhancements and bugs in the issues tab. If you have something you found a bug or have a new idea for a feature post it there.

Original Repository

This mod was originally made by ashbash1987 and was located here. Thanks to him for the original code which we continued from.

ktanetwitchplays's Issues

make letters optional

create a setting that allows you to toggle between the letters style of tagging, or the numbers style of tagging.

Add a search command.

Players have wondered about the possibility of adding two commands:

1.) A command to list any module of a given module name, with number and status.
2.) A command to list any/a selection of unclaimed modules, with numbers and names.

update command list

While this issue has been mostly resolved, there is still a lack of documentation concerning the ranked-user commands; they haven't been updated to reflect the changes in commands for mod+ and super-user+ users.

Feature Request? Per Bomb Leaderboard

As opposed to the blank/solo leaderboard appearing on the left hand side of the conclusion screen, it would be nice to see a mini-leaderboard showing just the stats from the bomb that just finished, as a way of measuring how well everyone did head to head on that one particular instance.

-From twitch chat suggestion.

Make find command target be case insensitive

Please make the find command target be case insensitive. I know I saw Nightmare use find for "Follow" searching for FTL, but it needed to be "follow" for the find to work right. Boo.

Many newer modules have default point settings

In particular Skyrim only gives out 5 points. That's a crime, man.

Claims queue suggestion

This suggestion is twofold.

The first suggestion is that claim commands should be held in a queue. If a module becomes available that you tried to claim before, or one of your own claim slots becomes available, TP would automatically allocate that module to you. Accordingly, the unclaim command would remove a module from your queue if it’s in the queue but not yet claimed.

The second suggestion is that if a player has played a specific module within the last X amount of time (24 hours?), they cannot claim a module within the first 10 seconds of the bomb, but instead their claim goes into their queue. If nobody else claims the module within those 10 seconds, nothing changes; all it does is give other people a chance to play the module so that one person with a slightly faster internet connection doesn’t hog it.

Finally, the !take command should also add the module to the queue so that it is automatically claimed when the player unclaims it or it becomes available after the timeout.

!rank command only lists one player even if multiple have the same rank

Add a "resetuser" command

Add a command that moderators could use that would reset a user's score, solves, and strikes. Currently this requires 4 steps.

Zen mode bombs can blow up

Due to zen mode bombs not carrying over the strike limit from bomb to bomb, zen mode bombs can blow up.

When a module is claimed to the queue...

When a module is claimed to the queue, it says, "Rexkix, you may only have 3 claimed modules."
Instead say, "Rexkix, you may only have 3 claimed modules. Claim is queued."

!rank command only lists one user when there are multiple

When two users have the same score, they occupy the same rank.

The following screenshot shows that the !rank command only lists one of them.

Make the Find command accept more than one module name.

A lot of the time people issue multiple find commands and it crowds the chat. Maybe it would be better if a bunch could be combined on one line. I don't know if the responses should be on one line or on separate lines.

Add a way to find if there are any duplicate modules

Mafia sometimes requires finding out if there are any duplicate modules, adding a command to rectify this may be helpful

make letter codes case insensitive

some commands involving letter codes have the codes as case-insensitive, some require capitals, consider making all commands have the codes as case-insensitive.

!help does strange stuff when between bombs

!help mentions gives "help" for two random numbered modules and it's not helpful info.

Again, this appears to have been introduced when module IDs changed from numbers to letters.

!claims no longer works when trying to check the claims of another user

as the title says

Some modules have their help messages removed when the mod is installed

Specifically tested with Cheap Checkout - but the count for "helpText": null goes up to 50 when running ktane through steam. When running locally with no changes to ModuleInformation.json, that count goes down to 17 (Mostly missing needies and translated modules, as I need to encounter them for their help messages to appear) and immediately goes back up to 50 when running with steam again.

With the current latest build of Twitch Plays ( bf56513), I have been seeing rising cases of help messages going missing when they had worked prior. After doing some testing, it appears that with modules that have help messages defined in ComponentSolverFactory help messages are not showing up when its related module is installed in any capacity. Running Ktane without these modules installed will have the help messages displayed correctly - however, running ktane with the modules installed will actually override working messages with "null" along with manual codes. (However, the default manual codes still show up when typing !{0} help)

Alternatively, I do believe that Twitch Plays should automatically add help messages if it detects null or blank messages. But this issue will still need to be addressed first before getting to that. Let me know if a separate issue should be added in regards to adding help messages in blank situations.

add a command that the streamer can use to instantly disable and enable all moderators apart from the streamer

Timemode appears to be broken

Timemode doesn't add time add when modules are solved. I think this happened when the module IDs changed from numbers to letters.

The resetuser command returns "User resetuser <username> not found."

The resetuser command returns "User resetuser not found." even when the username exists.

It looks as if Murder only accepts capitalized names / weapons / rooms

I just did a murder and it complained when I didn't capitalize the name / weapon / room.

Request: Banned rank

Would like an access level that can be assigned to users that prohibit them from making any commands that will be executed by the bomb (optimally, with option for if it gives a message or not).

Allow API to be called if not focused

Certain "API methods" would be useful if they could be called without having to focus in the module.
Basically any API that sends something to the chat should be able to do this.

Request: Restriction on on claimany/claimmod

Would be nice if these commands (and related commands) excluded souvenir, turn the key, and turn the keys (modules that can't be actively worked on by players, and would just eat up a claim slot)

Make an "unclaim all" command

Make an "unclaim all" command.

Feature request: Dynamic score being configurable.

General request, would be nice to have dynamic score set a variable percentage of points, instead of a flat 50%

Zoom bug

When playing with camera zoom, zooming out the bomb causes the module in the top-left view slot to pop-out of the bomb, causing a weird view glitch

New command: findplayer

For Souvenir, I find people often need to do a !find module to find a a module ID, then do !id player to see who did it.

Why not combine the two into a "findplayer" command?

:)

Limit the amount of module types one can do in a "findclaim" command

Lately, I've seen people gobble up all their favorite modules using a "findclaimall ;;;etc..." command. They've got it queued up in the beginning before the bomb is even shown. Personally I think this is greedy and rude. It also starts up a war of people competing with each other to do the same thing. This can get out of hand.

I recommend that you limit the number of module types that can be findclaim'ed. Also, I'd put a cooldown on repeated findclaim commands. This way they'd have to share modules with others.

Perspective Pegs Rotate - Always looking up from the bottom

Make it so that Perspective Pegs rotate always rotates with the bottom being viewed instead of sometimes being the top.

Round time when bomb explodes to nearest second.

Time when bomb blows up can be some small decimal value. Please round to the nearest second.

Make Murder cycle time be faster

Make Murder cycle time be faster. Especially make the room cycle time faster.

Minor bug: Reward distribution

The end-of-bomb reward for a successful disarming incorrectly reads the person who solves the last module as being added to the list after awards are given (thus, if that's their first module, they get no reward, but will on the next regardless)

Claim+view suggestion

The majority of the times someone claims a module, they also want to view it. Currently, this requires two separate commands (claim and view).

At the very least, it would be nice if one could write !# claim view in one command. However, even that is something the player can easily forgot and only notice after the Twitch stream delay.

Therefore, I think it would be preferable to default to viewing the module as part of the claim command so that the player doesn’t have to worry about it. (A separate !# claim noview command could be added, but it’s doubtful anybody would use it.)

Allow setting of different properties of the bomb

It's currently possible for Admins to change the different properties by adding or subtracting from the current amount, but it should also be possible to set the value directly.

Vanilla modules no longer accept commands

keypad, maze, complicated wires, password and wire sequences no longer accept commands.

camera wall produces an odd shadow in the default game room

sometimes, when the camera wall is enabled, an odd shadow is produced in the default gameplay room

Allow for !updatemessage [mod]

While it's common practice for people to edit their own ModuleInformation.json files at any time, and then use !reloaddata while they're streaming, it's come to my attention that there may be some people who stream via full screen or otherwise can't access their ModuleInformation file while they're streaming.

Is it possible to have a command that updates the help message or ManualID via a streamer-only or mod-only command?

And on that note, maybe an !updatetodefault [mod] or something? Since the moduleinformation doesn't update if there's new help text in the TwitchPlaysAssembly. (It's probably important to keep it like that so that people's individual changes don't get overridden by updates)

If you try to do a command to the wrong module and it's already been solved...

If you try to do a command to the wrong module and it's already been solved, it says that the module was claimed by somebody else. Instead say that it was solved already. Maybe also say who solved it, but that's not really necessary.

Listening requires the "press" command to be in lower case

Listening requires the "press" command to be in lower case.

General Help on a web page

If somebody does a !help command, TP should respond with help for some of the most basic commands (e.g. !25 claim or !25 view), but it should also give a link to a web page that documents all the general purpose commands (e.g. !find, etc.)

As it stands, many commands like !find are only known by people in the know. Others have to learn about them by watching them be used. There should be a place where people can learn about all the commands that are supported.

If it helps, I volunteer to help maintain this page.

Suggestion: have superusers and streamer ignore claim limit

sometimes, it may be useful for the superusers and streamer to claim modules without using the !assign command, as that takes a while to type out. This is mostly for TTKs

Fix messages that are too long to be sent to TP chat

Messages that are over ~500 characters^[source] can't be sent through IRC, so they should probably be broken up before being sent.

Consider automatically lower-casing commands

Some modules incorrectly accept only commands in lower case. At the risk of breaking future modules which could depend on case (which is a bad idea, IMO), lower case all commands (and arguments) for modules so they can't make that mistake.

Add a "!# points" command to see how many points a module is worth.

Please consider adding a "!# points" command to see how many points a module is worth. Thanks. :)

Add a "Notes" field

Sometimes people want to remember things like FMN numbers. Would be nice to have a separate field for storing notes.

Make findclaim only give you one version of a module

Maybe some like it the way it is, but I would prefer if "findclaim" only gave you one instance of the module, so you don't have people hording a whole bunch of the same module.

Add option to let everyone turn !timemode on or off

I leave my stream running while I'm gone, and people constantly message me about having to turn timemode on or off. Maybe implement an option where you can let everyone toggle timemode?

Allow holdables to be thrown

In VR you can throw holdables, consider having a toggle-able option to throw holdables.