{"id":19293643,"url":"https://github.com/mann-conomy/tf-particle-effects","last_synced_at":"2025-04-22T07:32:20.358Z","repository":{"id":249286845,"uuid":"795999082","full_name":"Mann-Conomy/tf-particle-effects","owner":"Mann-Conomy","description":"A Node.js wrapper for Team Fortress 2's in-game particle effects.","archived":false,"fork":false,"pushed_at":"2025-04-14T20:31:32.000Z","size":264,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-14T21:35:08.386Z","etag":null,"topics":["json","localization","mann-conomy","nodejs","particle-effects","tf2","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@mann-conomy/tf-particle-effects","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/Mann-Conomy.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,"zenodo":null}},"created_at":"2024-05-04T16:24:52.000Z","updated_at":"2025-04-14T20:30:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"ff319912-fc3f-4353-b3a6-95bae583376e","html_url":"https://github.com/Mann-Conomy/tf-particle-effects","commit_stats":null,"previous_names":["mann-conomy/tf-particle-effects"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mann-Conomy%2Ftf-particle-effects","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mann-Conomy%2Ftf-particle-effects/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mann-Conomy%2Ftf-particle-effects/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mann-Conomy%2Ftf-particle-effects/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mann-Conomy","download_url":"https://codeload.github.com/Mann-Conomy/tf-particle-effects/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250195054,"owners_count":21390230,"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":["json","localization","mann-conomy","nodejs","particle-effects","tf2","typescript"],"created_at":"2024-11-09T22:35:35.789Z","updated_at":"2025-04-22T07:32:20.350Z","avatar_url":"https://github.com/Mann-Conomy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tf-particle-effects\n\nA Node.js wrapper for Team Fortress 2's in-game particle effects.\n\n[![npm version](https://img.shields.io/npm/v/@mann-conomy/tf-particle-effects?style=flat-square\u0026logo=npm)](https://npmjs.com/package/@mann-conomy/tf-particle-effects)\n[![npm downloads](https://img.shields.io/npm/d18m/@mann-conomy/tf-particle-effects?style=flat-square\u0026logo=npm)](https://npmjs.com/package/@mann-conomy/tf-particle-effects)\n[![Node.js version](https://img.shields.io/node/v/@mann-conomy/tf-particle-effects?style=flat-square\u0026logo=nodedotjs)](https://nodejs.org/en/about/releases/)\n[![GitHub actions](https://img.shields.io/github/actions/workflow/status/Mann-Conomy/tf-particle-effects/test.yml?branch=main\u0026style=flat-square\u0026logo=github\u0026label=test)](https://github.com/Mann-Conomy/tf-particle-effects/blob/main/.github/workflows/test.yml)\n[![GitHub license](https://img.shields.io/github/license/Mann-Conomy/tf-particle-effects?style=flat-square\u0026logo=github)](https://github.com/Mann-Conomy/tf-particle-effects/blob/main/LICENSE)\n\n## Installation\n\nUsing [npm](https://www.npmjs.com/package/@mann-conomy/tf-particle-effects):\n\n```bash\n$ npm install @mann-conomy/tf-particle-effects\n```\n\nUsing [yarn](https://yarnpkg.com/package/@mann-conomy/tf-particle-effects):\n\n```bash\n$ yarn add @mann-conomy/tf-particle-effects\n```\n\n## Testing\n\nUsing [npm](https://docs.npmjs.com/cli/v8/commands/npm-run-script):\n```bash\n$ npm test\n```\n\nUsing [yarn](https://classic.yarnpkg.com/lang/en/docs/cli/run/):\n```bash\n$ yarn test\n```\n\n## Examples\n\nCreating and evaluating Unusual particle effects from the Team Fortress 2 game files.\n\n```js\nimport { UnusualEffect } from \"@mann-conomy/tf-particle-effects\";\n\ntry {\n    // Create a new Unusual effect to represent Burning Flames\n    const effect = new UnusualEffect({ name: \"Burning Flames\" });\n\n    // Evaluate the Unusual effect based on the provided name\n    if (effect.eval()) {\n        // Retrieve the Unusal effect's particle id and name\n        const { id, name } = effect.find();\n\n        console.log(id, name); // 13, Burning Flames\n    }\n} catch (error) {\n    console.error(\"Error processing Unusual effect\", error.message);\n}\n```\n\nWant to keep things simple without class instantiation? Opt for the static functions instead!\n\n```js\nimport { KillstreakEffect } from \"@mann-conomy/tf-particle-effects\";\n\ntry {\n    // Create a new Killstreak effect to represent Singularity\n    const effect = { id: 2006 };\n\n    // Evaluate the Killstreak effect based on the provided id\n    if (KillstreakEffect.eval(effect)) {\n        // Retrieve the Killstreak effect's name\n        const { name } = KillstreakEffect.find(effect);\n\n        console.log(\"Killstreaker:\", name); // Killstreaker: Singularity\n    }\n} catch (error) {\n    console.error(\"Error processing Killstreak effect\", error.message);\n}\n```\n\nSome more examples are available in the [examples](https://github.com/Mann-Conomy/tf-particle-effects/tree/main/examples) and [test](https://github.com/Mann-Conomy/tf-particle-effects/tree/main/test) directories.\n\n## Documentation\n\nSee the [Wiki pages](https://github.com/Mann-Conomy/tf-particle-effects/wiki) for further documentation.\n\n## License\n\n[MIT](LICENSE)\n\nCopyright 2025, The Mann-Conomy Project\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmann-conomy%2Ftf-particle-effects","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmann-conomy%2Ftf-particle-effects","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmann-conomy%2Ftf-particle-effects/lists"}