README.md

unusual-effects

A Node.js wrapper for Team Fortress 2's Unusual particle effects.

Installation

Using npm:

$ npm install unusual-effects

Using yarn:

$ yarn add unusual-effects

Testing

Using npm:

$ npm test

Using yarn:

$ yarn test

Examples

Importing with CommonJS

const { getEffectByName } = require('unusual-effects')

or with ES6's import statement

import { getEffectByName } from 'unusual-effects'

Get Backpack.tf particle images using the effect's name

console.log(getEffectByName('Nebula').images)

There are some more examples available in the test directory.

Documentation

Version 2.0.0 includes breaking changes, please see the newly updated Wiki pages for further documentation.

License

MIT

Copyright 2024, Simon Sørensen