Module pathfinding

@skeldjs/pathfinding

This package contains a useful pathfinding tool for the SkeldJS client, meant to be installed separately as an extension to @skeldjs/client with npm install --save @skeldjs/pathfinding or yarn add @skeldjs/pathfinding. It is also one package of a bigger project, skeldjs.

You can view auto-updating documentation for this package hosted at github pages at https://skeld.js.org/modules/pathfinding.html

Re-build colliders from Scratch

Colliders are dumped during game runtime by miniduikboot's Mini.Dumper BepInEx plugin.

The .json files outputed can be used with the postprocess.js script to filter out unnecessary and invalid colliders for movement.

The .txt files outputed from the script can be plcaed into /data/colliders with the filename being the id of the map that the colliders are from.

Then, running yarn build:colliders will convert those colliders into a single binary file which is parsed by the pathfinder at runtime.

Basic Usage

Go to a location or player

const pathfinder = new SkeldjsPathfinder(client);

pathfinder.go({ x: 5, y: 5 });
// or
pathfinder.go(player);

Go to a vent and enter it

pathfinder.vent(TheSkeldVent.Cafeteria);
await pathfinder.wait("pathfinding.end");

client.me.physics.entervent(TheSkeldVent.Cafeteria);

Follow a player

pathfinder.follow(player);

Advanced Usage

Follow a player but stop when you get too close

pathfinder.follow(player);

pathfinder.on("engine.move", ev => {
    const position = ev.position;
    const player_pos = player.transform.position;

    const dist = Math.hypot(
        position.x - player_pos.x,
        position.y - player_pos.y
    );

    if (dist < 1) {
        ev.cancel();
    }
});