{"id":13659887,"url":"https://github.com/wowserhq/spelunker","last_synced_at":"2025-08-20T19:25:15.692Z","repository":{"id":45953446,"uuid":"133146976","full_name":"wowserhq/spelunker","owner":"wowserhq","description":"Database explorer for World of Warcraft servers.","archived":false,"fork":false,"pushed_at":"2024-02-14T05:11:07.000Z","size":2173,"stargazers_count":17,"open_issues_count":20,"forks_count":5,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-10T13:35:56.279Z","etag":null,"topics":["wow"],"latest_commit_sha":null,"homepage":"https://spelunkerdb.com","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":null,"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}},"created_at":"2018-05-12T13:07:05.000Z","updated_at":"2024-10-05T20:12:34.000Z","dependencies_parsed_at":"2024-02-05T07:27:08.166Z","dependency_job_id":"4bc775b4-de3a-4ae2-bcb7-d8f17222a19b","html_url":"https://github.com/wowserhq/spelunker","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/wowserhq%2Fspelunker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wowserhq%2Fspelunker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wowserhq%2Fspelunker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wowserhq%2Fspelunker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wowserhq","download_url":"https://codeload.github.com/wowserhq/spelunker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248517391,"owners_count":21117443,"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":["wow"],"created_at":"2024-08-02T05:01:13.310Z","updated_at":"2025-04-12T04:33:07.893Z","avatar_url":"https://github.com/wowserhq.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Spelunker\n\n[![Version](https://img.shields.io/npm/v/@wowserhq/spelunker.svg)](https://www.npmjs.org/package/@wowserhq/spelunker)\n[![Join Community](https://img.shields.io/badge/discord-join_community-blue.svg?style=flat)](https://discord.gg/DeVVKVg)\n[![Known Vulnerabilities](https://snyk.io/test/github/wowserhq/spelunker/badge.svg)](https://snyk.io/test/github/wowserhq/spelunker)\n[![Maintainability](https://api.codeclimate.com/v1/badges/ad30d93353e35ebfdafe/maintainability)](https://codeclimate.com/github/wowserhq/spelunker/maintainability)\n\nDatabase explorer for World of Warcraft servers.\n\nLicensed under the [**MIT** license](LICENSE.md).\n\n![Spelunker](https://user-images.githubusercontent.com/378235/40316324-435d347a-5d1e-11e8-8d40-0e1dd2635213.png)\n\n## Features\n\nSpelunker exposes data from `auth`, `characters` and `world` databases as well as\nWorld of Warcraft's own game files through an [API]. Its [web client] can be used\nto conveniently browse the dataset, similar to [Wowhead].\n\nBoth parts are developed in unison in this repository using [Lerna], a tool for\nmanaging JavaScript projects with multiple packages.\n\n**Disclaimer:** To deliver game resources – such as icons – to the web client,\nSpelunker ships with a pipeline serving up resources to the browser over HTTP.\nDepending on your network configuration these may be available to others. Respect\nlaws and do not distribute game data you do not own.\n\nBe mindful of any privacy sensitive data – such as account and character names –\nyou may expose through Spelunker.\n\n### Supported servers and game versions\n\n- [Trinity Core] - 3.3.5a\n\nOther servers may be supported in the future. Pull requests welcome!\n\n## Usage\n\nNot yet available via [npm], but hopefully [soon™]!\n\nFor now, follow the development instructions below on how to get started.\n\n## Development\n\nSpelunker is developed with [Webpack] and [Babel], targeting modern JavaScript\nruntimes.\n\n1. Clone the repository:\n\n   ```shell\n   git clone git://github.com/wowserhq/spelunker.git\n   ```\n\n2. Download and install [Node] **10+** – including `npm` – for your platform.\n\n3. Install dependencies:\n\n   ```shell\n   (cd packages/spelunker-api \u0026\u0026 npm install)\n   (cd packages/spelunker-web \u0026\u0026 npm install)\n   ```\n\n4. Install [StormLib] and [BLPConverter], which are used to handle Blizzard's\n   game files.\n\n5. Copy `.envrc-sample` to `.envrc` and adjust accordingly.\n\n   In particular, verify `DATA_DIR` and `DATABASE_*` variables.\n\n   To configure [CORS], specify the allowed origin(s) in `CORS_ALLOWED_ORIGINS`\n   as a comma-separated list.\n\n6. Source the `.envrc` file:\n\n   ```shell\n   source .envrc\n   ```\n\n   Alternatively, use [direnv] and allow the changes:\n\n   ```shell\n   direnv allow\n   ```\n\n### API\n\nNavigate into the API package:\n\n```shell\ncd packages/spelunker-api\n```\n\nRun the API server:\n\n```shell\nnpm start\n```\n\nTo monitor source files and rebuild:\n\n```shell\nnpm run watch\n```\n\nThe API will be served on `http://localhost:3001`.\n\n### Web client\n\nNavigate into the web client package:\n\n```shell\ncd packages/spelunker-web\n```\n\n[webpack]'s development server monitors source files and rebuilds:\n\n```shell\nnpm start\n```\n\nThe web client will be served on `http://localhost:3000`.\n\n## Contribution\n\nWhen contributing, please:\n\n- Fork the repository\n- Open a pull request (preferably on a separate branch)\n\n[API]: /wowserhq/spelunker/tree/master/packages/spelunker-api\n[Babel]: http://babeljs.io/\n[Blizzardry]: https://github.com/wowserhq/blizzardry\n[BLPConverter]: https://github.com/wowserhq/blizzardry#blp\n[CORS]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS\n[Lerna]: https://github.com/lerna/lerna\n[Node]: http://nodejs.org/#download\n[StormLib]: https://github.com/wowserhq/blizzardry#mpq\n[Trinity Core]: https://github.com/TrinityCore/TrinityCore/tree/3.3.5\n[Wowhead]: http://www.wowhead.com/\n[direnv]: https://github.com/direnv/direnv\n[npm]: https://www.npmjs.com\n[soon™]: http://www.wowwiki.com/Soon\n[web client]: /wowserhq/spelunker/tree/master/packages/spelunker-web\n[webpack]: https://webpack.js.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwowserhq%2Fspelunker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwowserhq%2Fspelunker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwowserhq%2Fspelunker/lists"}