pkmn-screens
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

pkmn-screens

Pokémon screen image generator

Install

Install pkmn-screens:

npm i pkmn-screens

Generate a summary

Static move screen
import { Sets } from '@pkmn/sets';
import { Screens } from 'pkmn-screens';

//Pokémon Showdown! set
const set = Sets.importSet(
`Gekkouga (Greninja-Ash) (M) @ Choice Specs  
 Ability: Battle Bond  
 Level: 100  
 Shiny: Yes  
 Pokeball: Cherish Ball  
 EVs: 252 SpA / 4 SpD / 252 Spe
 Timid Nature
 - Hydro Pump
 - Dark Pulse
 - Water Shuriken
 - Spikes
`);

const buffer = await Screens.moves({ data: set, anim: false });

Result: Summary

Animated move screen
import { Sets } from '@pkmn/sets';
import { Screens } from 'pkmn-screens';

//Pokémon Showdown! set
const set = Sets.importSet(
`Yveltal @ Heavy-Duty Boots
 Ability: Dark Aura
 Level: 100
 Shiny: Yes
 EVs: 16 HP / 240 SpD / 252 Spe
 Jolly Nature
 - Knock Off
 - Taunt
 - Defog
 - Roost
`);

- const buffer = await Screens.moves({ data: set, anim: false });
+ const buffer = await Screens.moves({ data: set, anim: true });

Result: https://i.imgur.com/snFal5k.gif

Generate a party preview

Static party preview
import { summaryScreen, partyScreen } from 'pkmn-screens';

//array of 6 sets
const buffer = await Screens.party({
  data: team.map((s) => Sets.importSet(s)),
  anim: false,
});

Result: Party

Animated party preview
import { summaryScreen, partyScreen } from 'pkmn-screens';

//array of 6 sets
- const buffer = await Screens.party({
-    data: team.map((s) => Sets.importSet(s)),
-    anim: false,
-  });
+ const buffer = await Screens.party({
+   data: team.map((s) => Sets.importSet(s)),
+   anim: true,
+ });

Result: https://i.imgur.com/AtQ2bGK.gif

Donations

Donations are gladly accepted. Please send them to my Paypal.me to support the development, and maintenance of this project. Thank you!

Credits

This project currently being owned and maintained by castdrian.

Package Sidebar

Install

npm i pkmn-screens

Weekly Downloads

8

Version

2.0.0

License

MIT

Unpacked Size

536 kB

Total Files

67

Last publish

Collaborators

  • adrifcastr