{"id":21486953,"url":"https://github.com/ntsd/overwolf-nanostores","last_synced_at":"2025-03-17T10:14:12.067Z","repository":{"id":202628414,"uuid":"704619781","full_name":"ntsd/overwolf-nanostores","owner":"ntsd","description":"Nano Stores implement for Overwolf","archived":false,"fork":false,"pushed_at":"2023-10-25T15:41:01.000Z","size":54,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-02T05:51:26.764Z","etag":null,"topics":["game-overlay","hearthstone","league-of-legends","nanostores","overlay","overwolf"],"latest_commit_sha":null,"homepage":"https://ntsd.github.io/overwolf-nanostores/","language":"TypeScript","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/ntsd.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":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-13T16:52:05.000Z","updated_at":"2023-10-20T16:05:58.000Z","dependencies_parsed_at":"2024-11-23T13:30:36.147Z","dependency_job_id":"65c883c0-5ded-4c6b-8e90-4918aa8ee1cb","html_url":"https://github.com/ntsd/overwolf-nanostores","commit_stats":null,"previous_names":["ntsd/overwolf-nanostores"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntsd%2Foverwolf-nanostores","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntsd%2Foverwolf-nanostores/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntsd%2Foverwolf-nanostores/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntsd%2Foverwolf-nanostores/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ntsd","download_url":"https://codeload.github.com/ntsd/overwolf-nanostores/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244014186,"owners_count":20383716,"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":["game-overlay","hearthstone","league-of-legends","nanostores","overlay","overwolf"],"created_at":"2024-11-23T13:25:18.619Z","updated_at":"2025-03-17T10:14:11.471Z","avatar_url":"https://github.com/ntsd.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overwolf Nano Stores\n\n[![npm version](https://badge.fury.io/js/overwolf-nanostores.svg)](https://www.npmjs.com/package/overwolf-nanostores)\n\n[Nano Stores](https://github.com/nanostores/nanostores) implementation for Overwolf Plugin\n\n## Prerequisite\n\nNano Stores is a powerful state manager library designed to support multiple frontend frameworks and tiny bundle sizes.\n\nTo have [Overwolf API](https://overwolf.github.io/api) such as [Window](https://overwolf.github.io/api/windows), [Game Event](https://overwolf.github.io/api/games/events) stored in Nano Stores is an easy way to use the API and handle the state.\n\nSupported frameworks: React, React Native, Preact, Vue, Svelte, Solid, Lit, Angular, and vanilla JS.\n\nSee how to use Nano Stores in a different framework at [The Nano Store Guide](https://github.com/nanostores/nanostores#react--preact).\n\n## Installation\n\n`npm i overwolf-nanostores`\n\n## Documentation\n\nLink: https://ntsd.github.io/overwolf-nanostores\n\nDocumentation is generated by [TypeDoc](https://github.com/TypeStrong/typedoc).\n\n## Examples\n\nExample for `League of Legends` game\n\n```ts\nimport {\n  setGameEventRequiredFeatures,\n  gameInfoAtom,\n  gameEventAtom,\n} from \"overwolf-nanostores\";\n\n// Set required event features\n// check different game features from the Overwolf Docs\n// https://overwolf.github.io/api/live-game-data/supported-games/league-of-legends#available-features\nsetGameEventRequiredFeatures([\"gep_internal\", \"match_info\", \"chat\"]);\n\n// The subscribe will trigger every time when the Game Info is updated\ngameInfoAtom.subscribe((newInfo) =\u003e {\n  if (!newInfo) return;\n   // use condition to check the feature name\n  if (newInfo.feature === \"gep_internal\") {\n    console.log(\"Local + Public version number:\", JSON.stringify(newInfo.info));\n  }\n  if (newInfo.feature === \"match_info\") {\n    console.log(\"match info:\", JSON.stringify(newInfo.info));\n  }\n});\n\n// The subscribe will trigger every time when a new Game Event occurs\ngameEventAtom.subscribe((newEvent) =\u003e {\n  if (!newEvent) return;\n  newEvent.events.forEach((event) =\u003e {\n    // use condition to check the event name\n    if (event.name === \"chat\") {\n      console.log(\"new chat:\", event.data);\n    }\n  });\n});\n```\n\nIn the example,\n\n`gep_internal` and `match_info` are features for Game Info so they will trigger the `gameInfoAtom`\n\n`chat` is a feature for Game Event so it will trigger the `gameEventAtom`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntsd%2Foverwolf-nanostores","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fntsd%2Foverwolf-nanostores","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntsd%2Foverwolf-nanostores/lists"}