This Node.js package is a collection of useful functions for searching through and filtering Slippi replays.
With Node.js installed, simply run the following command to add the package to your project.
npm install slippi-searchThis will also add Project Slippi's @slippi/slippi-js as a dependency.
See some working examples, or check out the docs.
- Create a fresh directory on your disk
- Inside this new directory, create a file called
search.js - Fill the
search.jsfile with the following contents:
const {
withGamesFromDir,
isValidGame,
withMatchingFrames,
sortedFrames
} = require("slippi-search");
const { stages } = require("@slippi/slippi-js");
// Define game criteria
const gameCriteria = {
stageId: [stages.STAGE_BATTLEFIELD, stages.STAGE_DREAM_LAND],
players: [
{
characterId: [0, 20] // Captain Falcon, Falco
},
{
characterId: [19] // Sheik
}
],
isPAL: [false, true], // Can also just omit
isTeams: [false]
};
// Define frame criteria
const frameCriteria = {
players: [
{
pre: {
playerIndex: [1],
percent: [[10, 20]], // Between 10 and 20 percent
facingDirection: [-1]
}
}
]
};
const validGames = [];
const validFrames = [];
// With each game in the directory
withGamesFromDir("replays", game => {
// Check that game matches criteria
if (isValidGame(game, gameCriteria)) {
validGames.push(game);
// With each frame that matches criteria
withMatchingFrames(sortedFrames(game), frameCriteria, frame => {
validFrames.push(frame);
// Print info about players in frame
console.log(frame.players);
});
}
});- Change the "replays" path to some directory that holds some of your slp files.
- Browse to the directory from the command line and run the command:
npm install slippi-search. This should create anode_modulesdirectory in the folder. - Run the command:
node search.js. This will run the script above to search through and print data about the replay files that met the criteria in that directory.
This software is released under the terms of MIT license.