Atmosphere/docs/components/modules/ams_mitm.md

# ams_mitm
This module provides methods to intercept services provided by other system modules. It is further sub-divided according to the service it targets.

## bpc_mitm
bpc_mitm enables intercepting requests to power control services. It currently intercepts:
+ `am` system module (to intercept the Reboot/Power buttons in the overlay menu)
+ `fatal` system module (to simplify payload reboot logic significantly)
+ [nx-hbloader](https://github.com/switchbrew/nx-hbloader) (to allow homebrew to take advantage of the feature)

## fs_mitm
fs_mitm enables intercepting file system operations. It can deny, delay, replace, or redirect any request made to the file system. It enables LayeredFS to function, which allows for replacement of game assets.

## hid_mitm
hid_mitm enables intercepting requests to controller device services. It is currently disabled by default. If enabled, it intercepts:
+ [nx-hbloader](https://github.com/switchbrew/nx-hbloader) (to help homebrew not need to be recompiled due to a breaking change introduced in the past)

Note that hid_mitm is currently deprecated and might be removed entirely in the future.

## ns_mitm
ns_mitm enables intercepting requests to application control services. It currently intercepts:
+ Web Applets (to facilitate nx-hbloader web browser launching)

## set_mitm
set_mitm enables intercepting requests to the system settings service. It currently intercepts:
+ `ns` system module and games (to allow for overriding game locales)
+ All firmware debug settings requests (to allow modification of system settings not directly exposed to the user)

### Firmware Version
set_mitm intercepts the `GetFirmwareVersion` command, if the requester is `qlaunch` or `maintenance`.
It modifies the `display_version` field of the returned system version, causing the version to display
in settings as `#.#.#|AMS #.#.#|?` with `? = S` when running under system eMMC or `? = E` when running under emulated eMMC. This allows users to easily verify what version of Atmosphère and what eMMC environment they are running.

### System Settings
set_mitm intercepts the `GetSettingsItemValueSize` and `GetSettingsItemValue` commands for all requesters.
It does so in order to enable user configuration of system settings, which are parsed from `/atmosphere/system_settings.ini` on boot. See [here](../../features/configurations.md) for more information on the system settings format.
docs: initial re-write of all documentation 2020-04-26 19:06:59 +01:00			`# ams_mitm`
			`This module provides methods to intercept services provided by other system modules. It is further sub-divided according to the service it targets.`

			`## bpc_mitm`
			`bpc_mitm enables intercepting requests to power control services. It currently intercepts:`
docs: style fixes 2020-04-26 19:18:49 +01:00			+ `am` system module (to intercept the Reboot/Power buttons in the overlay menu)
			+ `fatal` system module (to simplify payload reboot logic significantly)
docs: address review commentary 2020-04-27 18:40:22 +01:00			`+ [nx-hbloader](https://github.com/switchbrew/nx-hbloader) (to allow homebrew to take advantage of the feature)`
docs: initial re-write of all documentation 2020-04-26 19:06:59 +01:00
			`## fs_mitm`
docs: hid_mitm is disabled by default 2020-04-26 21:01:54 +01:00			`fs_mitm enables intercepting file system operations. It can deny, delay, replace, or redirect any request made to the file system. It enables LayeredFS to function, which allows for replacement of game assets.`
docs: initial re-write of all documentation 2020-04-26 19:06:59 +01:00
			`## hid_mitm`
docs: hid_mitm is disabled by default 2020-04-26 21:01:54 +01:00			`hid_mitm enables intercepting requests to controller device services. It is currently disabled by default. If enabled, it intercepts:`
docs: address review commentary 2020-04-27 18:40:22 +01:00			`+ [nx-hbloader](https://github.com/switchbrew/nx-hbloader) (to help homebrew not need to be recompiled due to a breaking change introduced in the past)`

			`Note that hid_mitm is currently deprecated and might be removed entirely in the future.`
docs: initial re-write of all documentation 2020-04-26 19:06:59 +01:00
			`## ns_mitm`
			`ns_mitm enables intercepting requests to application control services. It currently intercepts:`
docs: address review commentary 2020-04-27 18:40:22 +01:00			`+ Web Applets (to facilitate nx-hbloader web browser launching)`
docs: initial re-write of all documentation 2020-04-26 19:06:59 +01:00
			`## set_mitm`
			`set_mitm enables intercepting requests to the system settings service. It currently intercepts:`
docs: style fixes 2020-04-26 19:18:49 +01:00			+ `ns` system module and games (to allow for overriding game locales)
docs: address review commentary 2020-04-27 18:40:22 +01:00			`+ All firmware debug settings requests (to allow modification of system settings not directly exposed to the user)`
docs: initial re-write of all documentation 2020-04-26 19:06:59 +01:00
			`### Firmware Version`
			set_mitm intercepts the `GetFirmwareVersion` command, if the requester is `qlaunch` or `maintenance`.
			It modifies the `display_version` field of the returned system version, causing the version to display
docs: address review commentary 2020-04-27 18:40:22 +01:00			in settings as `#.#.#\|AMS #.#.#\|?` with `? = S` when running under system eMMC or `? = E` when running under emulated eMMC. This allows users to easily verify what version of Atmosphère and what eMMC environment they are running.
docs: initial re-write of all documentation 2020-04-26 19:06:59 +01:00
			`### System Settings`
			set_mitm intercepts the `GetSettingsItemValueSize` and `GetSettingsItemValue` commands for all requesters.
			It does so in order to enable user configuration of system settings, which are parsed from `/atmosphere/system_settings.ini` on boot. See [here](../../features/configurations.md) for more information on the system settings format.