# Player Input
\nPlayer Input is a library specifically designed for handling polling based input detection, made possible by the type specific `input` field on players that gives us 20hz access to the keybinds `forward`, `backward`, `left`, `right`, `jump`, `sneak`, `sprint` at all times, in all game modes, regardless of context, except within GUIs.<\/p>\n
The goal of this library is two fold:<\/p>\n
1. Optimize actionable retrieval of this data; many packs need this data but its worse for performance for all of them to be polling at the same time.
\n2. Create easy & useful DX for tracking and acting on changes in this data.<\/p>\n
### Usage<\/p>\n
Packs that need access to this input data for few out of many players in specific scenarios should use the `capture\/player` path to begin tracking of the data.<\/p>\n
Packs that need access to input data for most\/all of players should use the `capture\/players` path to begin tracking of the data, and call the `release\/players` when the data is no longer needed (use `#minecraft:unload` if the data is needed all of the time)<\/p>\n
When data is being received, the exclusive `player_input.*` `\/tag` labels are always made available.<\/p>\n
Packs that need to do their own custom tracking every tick regardless of if the binds change can use the `raw` entrypoint. If only some players need to be checked use the `#player_input:player\/raw` function tag (called as\/at each player) and use your own `\/tag` label to filter players your pack is operating with as the function tag will be called for all usage of the library.<\/p>\n
Events: <\/p>\n
These entrypoints are called as\/at players that match the required state along with context data made available to functions in each tag, enabling event-based handling, instead of checking for state every tick.<\/p>\n
To subscribe to any of these, call the appropriate capture function, then to clean up after usage, call the release function.<\/p>\n
As with `raw`, make sure to `\/tag` players that your pack is specifically handling, as the function tag will be called for all usage of the library.<\/p>\n
– `key_update` – Called as\/at players whose input stack has changed from the previous tick.
\n – Tracked via the exclusive `player_input.previous.*` `\/tag` labels and the `player_input.current_tick`\/`player_input.previous_tick` composite Scores on the player.
\n – This context is also available for the following events.
\n– `key_down` – Called as\/at players that **were not** holding down any given key(s) in the previous tick and started to.
\n – Tracked via the exclusive `player_input.down.*` `\/tag` labels and the `keys_down player_input.current_tick` composite Score during execution.
\n– `key_up` – Called as\/at players that **were** holding down any given key(s) in the previous tick and released them.
\n – Tracked via the exclusive `player_input.up.*` `\/tag` labels and the `keys_up player_input.current_tick` composite Score during execution.<\/p>\n
### Example<\/p>\n
`jetpack:jetpack\/equip`
\n“`mcfunction
\ntag @s add jetpack.equipped<\/p>\n
function player_input:capture\/player\/key_update<\/p>\n
# Jetpack Things…
\n“`<\/p>\n
`jetpack:input_received`
\n“`mcfunction
\nexecute if entity @s[tag=jetpack.equipped] run function jetpack:jetpack\/control
\n“`<\/p>\n
`jetpack:jetpack\/control`
\n“`mcfunction
\n# Handle changes to player input
\n“`<\/p>\n
`jetpack:jetpack\/unequipped`
\n“`mcfunction
\ntag @s remove jetpack.equipped<\/p>\n
function player_input:release\/player\/key_update<\/p>\n
# Jetpack Things…
\n“`<\/p>\n
`#player_input:player\/key_update`
\n“`json
\n{
\n “values”: [
\n “jetpack:input_received”
\n ],
\n “replace”: false
\n}
\n“`<\/p>\n
### Plans
\n– Create a couple full proof-of-concept survival packs using this library and Player Motion.
\n– Reimplement in the Sandstone official `player` library
\n– Create a vanilla usage harness and deploy it to this repo
\n– Archive the current manually written vanilla code, automatically publish generated code to this repository.
\n– Port proof-of-concept packs to Sandstone.
\n– Maintain for changes in minecraft updates.<\/p>\n","protected":false},"excerpt":{"rendered":"
Handles polling based input detection, made possible by the type-specific input field on players, provides easy & useful DX for tracking and acting on changes in this data.<\/p>\n","protected":false},"featured_media":122608,"template":"","meta":{"_minecraft_slug":"player_input","_minecraft_project_id":"m4ZxIWME","_minecraft_author":"MulverineX","_minecraft_license":"MIT","_minecraft_downloads":93,"_minecraft_follows":0,"_minecraft_client_side":"optional","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"player_input.zip","_minecraft_size_bytes":17230,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-15T22:25:35.321028Z","_minecraft_date_created":"2024-09-26T05:25:53.684818Z","_minecraft_date_modified":"2025-11-18T19:31:49.587227Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/player_input","_minecraft_icon_attachment_id":122608,"_minecraft_imported_at":"2026-06-07T05:00:40+00:00","_minecraft_import_hash":"d52c5f7bd131a554e468343d50f879d1","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[84,89,873,90],"mod_loader":[86],"minecraft_version":[40,73,74,38,78,79,80,81,82],"class_list":["post-122607","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-datapack","mod_category-game-mechanics","mod_category-library","mod_category-optimization","mod_loader-datapack","minecraft_version-1-21-10","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n