# twitch-chat-emotes-threejs

> A library to use `twitch-chat-emotes` with ThreeJS

Latest version **0.4.3** (published 2023-12-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install twitch-chat-emotes-threejs
pnpm add twitch-chat-emotes-threejs
yarn add twitch-chat-emotes-threejs
bun add twitch-chat-emotes-threejs
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.3 |
| Published | 2023-12-05 |
| First published | 2021-11-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 14.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | calebbabin |

## Links

- npm: https://www.npmjs.com/package/twitch-chat-emotes-threejs
- Repository: https://github.com/moonscreens/twitch-chat-emotes-threejs
- Homepage: https://github.com/moonscreens/twitch-chat-emotes-threejs#readme
- Issues: https://github.com/moonscreens/twitch-chat-emotes-threejs/issues
- npm.io page: https://npm.io/package/twitch-chat-emotes-threejs

## Dependencies (1)

- [twitch-chat-emotes](https://npm.io/package/twitch-chat-emotes.md) ^0.4.3

## Recent versions

- 0.4.3 (latest) — 2023-12-05
- 0.4.1 — 2023-01-30
- 0.4.0 — 2023-01-30
- 0.3.11 — 2022-10-29
- 0.3.10 — 2022-10-29
- 0.3.9 — 2022-08-11
- 0.3.8 — 2022-08-10
- 0.3.7 — 2022-08-09
- 0.3.6 — 2022-07-18
- 0.3.5 — 2022-07-12
- 0.3.4 — 2022-07-07
- 0.3.3 — 2022-07-03
- 0.3.2 — 2022-03-10
- 0.3.1 — 2022-03-10
- 0.3.0 — 2022-01-27
- … 3 more at https://npm.io/package/twitch-chat-emotes-threejs/versions

## README

# twitch-chat-emotes-threejs
A Three.JS specific variant of the [twitch-chat-emotes](https://github.com/CalebBabin/twitch-chat-emotes) package.

[Example repository](https://github.com/moonscreens/intro-example-threejs)

```js
import TwitchChat from 'twitch-chat-emotes-threejs';

const ChatInstance = new TwitchChat({
	// If using planes, consider using MeshBasicMaterial instead of SpriteMaterial
	materialType: THREE.SpriteMaterial,

	// Passed to material options
	materialOptions: {
		transparent: true,
	},

	materialHook: material => console.log, // receives unique emote materials on creation
	textureHook: texture => console.log, // receives unique emote textures on creation

	channels,
	maximumEmoteLimit: 3,
});

ChatInstance.listen((emotes) => { //receives an array of "emote" objects, THREE.js material is within emotes[i].material
	console.log(emotes);
});
``

---
_Source: https://npm.io/package/twitch-chat-emotes-threejs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._