{"id":20363999,"url":"https://github.com/wowserhq/stormjs","last_synced_at":"2025-06-29T00:34:57.506Z","repository":{"id":143830918,"uuid":"116499950","full_name":"wowserhq/stormjs","owner":"wowserhq","description":"StormLib for Javascript, powered by Emscripten","archived":false,"fork":false,"pushed_at":"2020-05-27T06:17:50.000Z","size":1009,"stargazers_count":16,"open_issues_count":3,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-22T20:21:56.759Z","etag":null,"topics":["mpq","stormlib","wow","wowser"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wowserhq.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-01-06T16:58:05.000Z","updated_at":"2025-05-05T13:26:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"feb6bb4f-9315-4aca-a081-d69c640606c6","html_url":"https://github.com/wowserhq/stormjs","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/wowserhq/stormjs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wowserhq%2Fstormjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wowserhq%2Fstormjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wowserhq%2Fstormjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wowserhq%2Fstormjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wowserhq","download_url":"https://codeload.github.com/wowserhq/stormjs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wowserhq%2Fstormjs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261885315,"owners_count":23224886,"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":["mpq","stormlib","wow","wowser"],"created_at":"2024-11-15T00:09:18.019Z","updated_at":"2025-06-29T00:34:57.490Z","avatar_url":"https://github.com/wowserhq.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# StormJS\n\n[![Join Community](https://badgen.net/badge/discord/join%20community/blue)](https://discord.gg/DeVVKVg)\n[![Version](https://badgen.net/npm/v/@wowserhq/stormjs)](https://www.npmjs.org/package/@wowserhq/stormjs)\n[![MIT License](https://badgen.net/github/license/wowserhq/stormjs)](LICENSE)\n[![CI](https://github.com/wowserhq/stormjs/workflows/CI/badge.svg)](https://github.com/wowserhq/math/actions?query=workflow%3ACI)\n[![Test Coverage](https://codecov.io/gh/wowserhq/stormjs/branch/master/graph/badge.svg)](https://codecov.io/gh/wowserhq/stormjs)\n\nStormJS is [StormLib](http://www.zezula.net/en/mpq/stormlib.html) for Javascript, powered by\n[Emscripten](http://emscripten.org).\n\n[StormLib](http://www.zezula.net/en/mpq/stormlib.html) is copyright © Ladislav Zezula. It is\nlicensed under the [**MIT** license](https://github.com/ladislav-zezula/StormLib/blob/master/LICENSE).\nSee `src/vendor/StormLib/LICENSE` for more information.\n\n## Usage\n\nTo install StormJS:\n\n```sh\nnpm install @wowserhq/stormjs\n```\n\nTo use StormJS in an ES2015 module environment:\n\n```js\nimport { FS, MPQ } from '@wowserhq/stormjs';\n\n// Mount the local filesystem path /home/wowserhq/example as /stormjs\n// This approach is suitable for cases where StormJS is running under Node\nFS.mkdir('/stormjs');\nFS.mount(FS.filesystems.NODEFS, { root: '/home/wowserhq/example' }, '/stormjs');\n\nconst mpq = await MPQ.open('/stormjs/example.mpq', 'r');\nconst file = base.openFile('example.txt');\nconst data = file.read();\n\n// Clean up\nfile.close();\nmpq.close();\n```\n\nNote that StormJS loads in production mode if `NODE_ENV` is set to `production`. In all other cases, StormJS loads in debug mode.\n\n## Compatibility\n\nStormJS is tested against Node 10, 12, and 14.\n\nAdditionally, StormJS should work well in browsers with support for WASM. Note that use in browsers will require configuring an Emscripten filesystem type appropriate for the browser.\n\n## Development\n\nDevelopment of StormJS requires git, CMake, and an Emscripten environment.\n\n[emsdk](https://github.com/juj/emsdk) is the simplest way to get an Emscripten environment up and running.\n\nStormJS is currently built using Emscripten 1.39.15.\n\nAfter cloning the StormJS repo, ensure all submodules are also pulled down from remote by running:\n\n```sh\ngit submodule update --init --recursive\n```\n\nTo build StormJS after making changes locally, run:\n\n```sh\nnpm run build\n```\n\nThe test suites for StormJS can be run using:\n\n```sh\nnpm run test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwowserhq%2Fstormjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwowserhq%2Fstormjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwowserhq%2Fstormjs/lists"}