@mann-conomy/tf-particle-effects
v1.1.2
Published
A Node.js wrapper for Team Fortress 2's in-game particle effects.
Downloads
88
Maintainers
Readme
tf-particle-effects
A Node.js wrapper for Team Fortress 2's in-game particle effects.
Installation
Using npm:
$ npm install @mann-conomy/tf-particle-effects
Using yarn:
$ yarn add @mann-conomy/tf-particle-effects
Testing
Using npm:
$ npm test
Using yarn:
$ yarn test
Examples
Creating and evaluating Unusual particle effects from the Team Fortress 2 game files.
import { UnusualEffect } from "@mann-conomy/tf-particle-effects";
(async () => {
try {
// Create a new Unusual Effect to represent Burning Flames
const effect = new UnusualEffect({ name: "Burning Flames" });
// Evaluate the particle effect based on the provided name
if (effect.eval()) {
// Retrieve the effect's particle id and name
const { id, name } = effect.find();
console.log(id, name); // 13, Burning Flames
}
} catch (error) {
console.error("Error processing effect", error.message);
}
})();
Some more examples are available in the examples and test directories.
Documentation
See the Wiki pages for further documentation.
License
Copyright 2024, The Mann-Conomy Project