Souvenir

Intro

This is a mod module for Keep Talking and Nobody Explodes. This module asks you questions about some of the other modules on your bomb after you’ve solved them. It requires you to remember or write down things that you used to solve those other modules.

A build is available on the Steam Workshop. The manual is available on the Repository of Manual Pages.

Based on the Keep Talking and Nobody Explodes modkit.

Contributing

If you wish to see another module added, you can contribute development by submitting pull requests or finding a volunteer modder on the KTaNE Discord server. Additions would generally be required to satisfy the following guidelines:

• No questions about things that can just be read off after the module is solved (e.g. the symbols in Astrology). However, Souvenir may hide this information on some modules, such as Adventure Game.
• No questions about things that can be re-deduced by re-solving the module (e.g. offset in Caesar Cipher).
• No questions about random things that aren’t required for solving a module (e.g. initial red/green state in Connection Check).
• No questions that could under any circumstances be impossible to answer. This includes things that are removed/reset when striking on a module.
• No questions about modules that are part of an ongoing manual challenge.
• Questions about boss modules are allowed as long as they satisfy the above guidelines. The boss modules should remain on Souvenir’s ignore list.
• Prefer questions that ask what was actually shown on the module rather than what the defuser had to input to solve it (e.g. prefer displayed digits over calculated digits in Forget Me Not).

The following vanilla modules are supported by Souvenir: The Button, Maze, Memory, Simon Says, Wire Sequence. These may be excluded using a setting in the ModSettings file. This file will be created the first time a Souvenir module is loaded on a bomb. After that, the mod settings may be edited using a text editor or the Mod Selector tablet with the Tweaks mod. Souvenir itself and other boss modules may also be excluded this way.

Building

• In Unity, build Souvenir without a separate assembly (keyboard: F7; menu: “Keep Talking ModKit” → “Build AssetBundle (no assembly)”).
• The compiled binary SouvenirLib.dll is included in the git repo to allow people to build Souvenir in Unity without needing to compile the source.

Translations

For contributing to translations, see translations.md.

Adding new module support

First, ensure that there isn’t already a contributor working on adding the module you are hoping to implement. The KTANE Discord server has a thread for this (https://discord.com/channels/160061833166716928/1133454524435148860) where our efforts are coordinated.

The actual source code is in Lib. Open Lib/SouvenirLib.sln in Visual Studio to get started.

If your installation of KTANE is not in the default folder (C:\Program Files (x86)\Steam\steamapps\common\Keep Talking and Nobody Explodes\), create a SouvenirLib.csproj.user file containing this and change the folder accordingly. You MUST end your path with a backslash (\).

<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
    <ProjectView>ProjectFiles</ProjectView>
    <GameFolder>F:\SteamLibrary\steamapps\common\Keep Talking and Nobody Explodes\</GameFolder>
  </PropertyGroup>
</Project>

To add a new module, the following steps are required:

• Unsubscribe from the Workshop version of Souvenir.
• Build the asset bundle in Unity with no assembly (F7) and copy the result to your game’s mods folder. You only need to do this once as long as you keep that local copy of Souvenir there.
• In Question.cs, add a separate value for each possible type of question that can be asked. Keep newlines between the modules; no newlines between questions for the same module.
  • If your question has a specific set of possible answers, list them all (example: SuperparsingDisplayed).
  • If your handler will obtain the set of possible answers from the module, specify null and then use the ExampleAnswers field (example: SpellingBeeWord).
  • If the possible answers are random strings of letters or digits, use an answer generator (example: LasersHatches (integers); LEDEncryptionPressedLetters (strings)).
  • If your question can be varied with things inserted into the sentence (e.g. “left display” vs. “right display”), use {1}, {2} etc. for those inserted bits, and then make sure to supply ExampleExtraFormatArguments and ExampleExtraFormatArgumentGroupSize correctly (examples: DecoloredSquaresStartingPos (one piece, so group size is 1); RedCipherScreen (two pieces, so group size is 2 and the example arguments come in pairs)).
  • If the inserted bit is an ordinal number (first, second, third, etc.), use QandA.Ordinal instead of a string (example: SwitchInitialColor).
  • If your targeted module’s name starts with “The”, make sure to specify the name without “The” but include AddThe = true (example: DeckOfManyThingsFirstCard).
  • Make sure to specify the correct values for TranslateAnswers and TranslateFormatArgs. If a word or phrase is used to ask a question (e.g. “flash”/“didn’t flash”) or describe something (e.g. color of a button), make it translatable (example: IndigoCipherScreen). If a word or phrase is mentioned that is literally shown on the module, then do not make it translatable (example: IdentityParadeHairColors).
• Add a string constant in Modules_General.cs containing the ModuleType value on the targeted module’s KMBombModule component. This is also sometimes known as the “module ID”. For example, for 3D Maze, this is spwiz3DMaze. Omit “The” in the constant name (for example: _Bulb, not _TheBulb).
• Find an existing handler for a module that is similar to the one you wish to implement. The handlers have names beginning with Process (for example: ProcessMafia in ModulesM.cs). Study it carefully to understand how it works. There is documentation at documentation.md.
• Implement a similar handler and place it alphabetically in the correct file (ModulesA.cs to ModulesZ.cs, or Modules0.cs). Omit “The” in the handler name as well.
  • Make sure to handle the case where the player gets a strike on the module and the information changes. Souvenir must not ask about information from stages that struck.
  • If there is a corner case where Souvenir should not ask a question, call legitimatelyNoQuestions with an appropriate log message (see ProcessLangtonsAnteater or ProcessSimonSignals for examples).
• Go back to Modules_General.cs, find the Awake() method, and add an entry to the large dictionary mapping from your string constant to a 3-tuple containing: the method you just created; the display name of the module; and your name (you will be credited in CONTRIBUTORS.md).
• Compile the project.
• Run Souvenir in Unity and issue a TP command (such as !1 bulb) to see your question to make sure that it looks okay.
• Test your Souvenir modifications in-game (e.g. by using Dynamic Mission Generator). Test all corner cases, including getting a strike on the module.
• If your question does not show up and/or Souvenir displays a warning triangle, look at your logfile for error messages from Souvenir. You can Ctrl+F in the logfile for <Souvenir to find them.
• Please make a separate git commit for each module you implement. If you made multiple commits for the same module, please squash them into one.
• After submitting the pull request, DM me (Timwi on Discord) the questions to be added to the manual, in the format Module Name: Question? Question?, for example:

      Quiz Buzz: What was the number initially on the display?
      Memory Wires: What were the wire colours? What were the displayed digits?
      The Matrix: Which word was part of the latest access code? What was the glitched word?
  

  I will do the rest to update the manual and the info on the repo.