City Bag Checks Readme

*****************************************************************


                    THE ELDER SCROLLS V: SKYRIM
		          CITY BAG CHECKS
			   Version 1.0.4


*****************************************************************

Index:
1. Installation
2. Description
3. Configuration
4. Change List
5. F.A.Q.
6. Uninstallation


*****************************************************************

     1. Manual Installation

*****************************************************************

1. Unzip the contents of the mod to your Skyrim Data folder. Below is a list of the default
   Skyrim installation locations:

	C:\Program Files (x86)\Steam\steamapps\common\Skyrim\Data

		For Special Edition Edition:

	C:\Program Files (x86)\Steam\steamapps\common\Skyrim Special Edition\Data

2. Confirm you have the following files in your Skyrim data folder:

	City Bag Checks.esp
	City Bag Checks.bsa
	City Bag Checks - Textures.bsa (Skyrim Special Edition only)

3. Run the Skyrim Launcher. Go to Data Files and make sure City Bag Checks.esp is loaded
   after your master files.

   For Special Edition, open %userprofile%\AppData\Local\Skyrim Special Edition\plugins.txt
   and add *City Bag Checks.esp after your master files.

4. Save.

5. Launch the game.


*****************************************************************

     2. Description

*****************************************************************

City Bag Checks gives guards the job of randomly checking bags for illicit goods when approaching
a major city.

Key Features:

Randomized Bag Inspections: Upon approaching the gates of a major city, guards may perform a bag
check on you and your companion for stolen items and narcotics such as: Moon Sugar, Skooma,
Sleeping Tree Sap, Balmora Blue and Double Distilled Skooma. Seized items will be taken to the
stolen items evidence chest at the local jail.

Options for Passing a Check: There are numerous ways to try to avoid a bag check, such as Persuasion,
Bribery, or reminding the guard that you're Thane of the Hold.

Commentary on Questionable Items: Items such as Human Hearts, Human Flesh, Black Soul Gems, and certain
books, though not expressly illegal, may prompt a reaction from the guards during a bag check.

Seamless Integration: City Bag Checks integrates seamlessly with the existing crime system. If you're
caught with stolen items or narcotics, or threaten a guard with physical violence, you will receive a
bounty and the bag check will become an arrest. The new lines of dialogue included in this mod have
been generated using Tortoise TTS and RVC and should be almost indistinguishable from the original voice
acting.

An MCM is included to allow you to adjust how frequently bag checks occur. When the bag check event
occurs, a random guard closest to the main external gate is chosen to do the check. If you fast travel
directly into the city, a check will not occur.


*****************************************************************

     3. Configuration

*****************************************************************

You can use the following console command to manually adjust bag check chance, if you don't want
to install SKSE and SkyUI:

	set CBC_LocationEncounterChance to #		(0 - 100%)


*****************************************************************

     4. Change List

*****************************************************************

1.0.0 - Initial Release on Nexus Mods and Steam.

1.0.1 - Fixed issue with bag check not completing when a companion was present.

1.0.2 - Renamed the script fragments, adding the CBC extension to avoid any conflicts with other mods.

      A huge thanks to St1ck2k22 for the following:

      - Prevented comments about questionable items from taking precedent over a contraband detection.
      - Walking away from a bag check now triggers resist arrest behaviour.
      - Bag checks shouldn't trigger again if the player pays the fine or goes to prison.
      - Removed some redundant dialogue.
      - Updated the CurrentFollower alias just before the check in case the player hires or dismisses
        their companion after the bag check event starts.
      - Added a check for stolen goods (For SSE only! LE lacks the functions for this feature).

1.0.3 - Added a condition to the forcegreet package and guard dialogue to only trigger if the player
        is in the Tamriel worldspace.

1.0.4 - The player is no longer flagged as 'Protected' when a bag check is active and has no
        companion.
      - Fixed an issue that caused the dialogue to quit out if the player had multiple kinds of
        contraband in their inventory.


*****************************************************************

     5. F.A.Q

*****************************************************************

Q. What patch level is required?
A. None.

Q. Do I need Dawnguard, Hearthfire or Dragonborn or additional plugins like SKSE?
A. You'll need SKSE and SkyUI in order to adjust mod settings, but it's not required for the mod to
   function. The % chance of a bag check can still be controlled via console commands.

Q. Why am I not encountering a bag check?
A. Bag checks may not occur if all the guards standing near the gate (in the Tamriel worldspace) are
   dead.

   Bag checks are not meant to occur in the city world spaces. If you fast travel into a city you
   will skip a potential bag check.

   The game checks for guards standing near the gate with the following Ref Type: CWMainGateExterior.
   If you have a mod installed that removes this keyword from the gate, it will prevent a guard from
   being picked.

   Some cities have secondary gates. Bag checks will not happen at these gates.

   Lastly, only one bag check event can occur at a time. Bag check events only end when you walk into
   a wilderness cell to help prevent multiple events from occurring as you enter/leave houses.

Q. Why is Balmora Blue or Double Distilled Skooma not getting removed from my inventory?
A. They're quest items, so for the sake of not potentially breaking quests I've excluded them from
   removal. You'll still get in trouble if you're caught with them in your inventory.


*****************************************************************

     6. Uninstallation

*****************************************************************

The easiest way to disable the mod is to untick Toggle Bag Checks in the MCM. But if you want to
remove the mod permanently:

1. Close the game.

2. Remove the City Bag Checks.esp and City Bag Checks.bsa files from your Skyrim data
   folder. By default this should be either of the following locations:

	C:\Program Files\Steam\steamapps\common\skyrim\data

			or for 64-bit Windows:

	C:\Program Files (x86)\Steam\steamapps\common\skyrim\data

3. Refer to SuperSajuuk's document on manually removing any left-over CBC_* script files from
   your save file:

   https://www.dropbox.com/s/lj6d98yy8ohcoh3/Uninstalling%20Skyrim%20Mods.pdf?dl=0

   Note: You should not experience any problems with stability if you do not clean these script
   files from your save.