{"id":22447596,"url":"https://github.com/mattms/esm_reader","last_synced_at":"2026-01-06T17:10:55.488Z","repository":{"id":57230406,"uuid":"48422480","full_name":"MattMS/ESM_reader","owner":"MattMS","description":"Extract data from Fallout 3 ESM files.","archived":false,"fork":false,"pushed_at":"2017-01-23T09:44:18.000Z","size":130,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-04T14:05:47.122Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MattMS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-12-22T09:18:17.000Z","updated_at":"2021-05-20T19:11:53.000Z","dependencies_parsed_at":"2022-09-14T15:01:57.992Z","dependency_job_id":null,"html_url":"https://github.com/MattMS/ESM_reader","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MattMS%2FESM_reader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MattMS%2FESM_reader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MattMS%2FESM_reader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MattMS%2FESM_reader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MattMS","download_url":"https://codeload.github.com/MattMS/ESM_reader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245835040,"owners_count":20680130,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-06T04:17:49.758Z","updated_at":"2026-01-06T17:10:55.461Z","avatar_url":"https://github.com/MattMS.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Read Fallout 3 ESM files\n\n**Please note:** This is a work in progress.\nIt is only partially implemented and barely tested.\nCome back later.\n\nThis package parses the `*.esm` data files used by Fallout 3 and exposes the data as Objects via a Node.js Stream.\n\nAnother aim of this project is to provide documentation of the file format.\n\n\n## Usage\n\nAdd this as a dependency to your project:\n\n\tnpm install esm_reader --save\n\n\n## File structure and parsers\n\nValues are stored in [little endian](https://en.wikipedia.org/wiki/Endianness) format.\nThis controls the Node Buffer methods to use.\n\nFiles always start with a TES4 record.\n\nThe rest of the file is divided into groups, described next.\n\n[parser/main.coffee.md](./parser/main.coffee.md) switches to the appropriate parser based on the current state.\n\n\n### Groups\n\n[read_group_header.coffee.md](./read_group_header.coffee.md) parses the start of each group.\n\nThe rest of the group is made up of records, described next.\n\n\n### Records\n\n[read_record_header.coffee.md](./read_record_header.coffee.md) parses the start of each record.\n\nThe rest of the record is made up of fields, described next.\n\n\n### Fields\n\n[read_field.coffee.md](./read_field.coffee.md) parses field data from a Buffer.\n\nA field contains a 4 byte label and then 2 bytes indicating the size of the field data.\nThe remaining bytes store the value of the field.\n\nFields can contain different types of values: text, numbers, bit flags, or lists of those.\nThe type of the value are not described by the field, but rather determined by the labels of the group+record+field.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattms%2Fesm_reader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmattms%2Fesm_reader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattms%2Fesm_reader/lists"}