Skip to content

dezchai/cursory

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cursory

TypeScript port of the original Python project Vinyzu/cursory.

This package generates human-like mouse trajectories by selecting from a dataset of recorded trajectories, morphing them to the requested start and end points, and re-sampling them with timing noise.

Install

npm install @dezchai/cursory
bun add @dezchai/cursory

If you are using this repository directly:

npm install
bun install

Basic Usage

import { generateTrajectory } from "@dezchai/cursory";

const { points, timings } = generateTrajectory([0, 0], [200, 100]);

Example Trajectories

These visuals come from the original project and illustrate the style of generated paths:

Random Points Same Points Points / Velocity
Random Points Same Points Points / Velocity

API

generateTrajectory(start, end, options?)

Generates a trajectory between two points.

import { generateTrajectory, type Point, type RandomSource } from "@dezchai/cursory";

const start: Point = [25, 40];
const end: Point = [640, 360];

const result = generateTrajectory(start, end, {
  frequency: 60,
  frequencyRandomizer: 1,
});

console.log(result.points);
console.log(result.timings);

Parameters

  • start: [number, number] - starting point.
  • end: [number, number] - ending point.
  • options.frequency?: number - target sample rate in Hz. Defaults to 60.
  • options.frequencyRandomizer?: number - maximum per-sample timing jitter in milliseconds. Defaults to 1.
  • options.random?: { next(): number } - optional deterministic random source for repeatable outputs.

Returns

  • points: [number, number][] - sampled trajectory points.
  • timings: number[] - timestamps in milliseconds, aligned with points.

getTrajectoryCount()

Returns the number of bundled source trajectories in the dataset.

Deterministic Usage

You can pass a custom random source if you want reproducible output for tests or debugging.

import { generateTrajectory, type RandomSource } from "@dezchai/cursory";

class SeededRandom implements RandomSource {
  private state: number;

  constructor(seed: number) {
    this.state = seed >>> 0;
  }

  next(): number {
    this.state = (1664525 * this.state + 1013904223) >>> 0;
    return this.state / 0x100000000;
  }
}

const result = generateTrajectory([0, 0], [300, 180], {
  random: new SeededRandom(12345),
});

Compatibility

This package is built for modern ESM runtimes and can be installed with either npm or Bun.

  • Package managers: npm, Bun
  • Runtimes: Node.js, Bun
  • Module format: ESM
  • Published entrypoint: dist/index.js

Copyright and License

This project is licensed under GPL-3.0-or-later.

The bundled trajectory dataset and original methodology come from Vinyzu/cursory and remain subject to the same license terms.

Commercial usage is allowed under GPL terms, which means source, license, and copyright notices must remain available.

Credits

Disclaimer

This repository is provided for educational purposes only.

No warranties are provided regarding accuracy, completeness, or suitability for any purpose. Use at your own risk. The authors and maintainers assume no liability for damages, legal issues, or warranty breaches resulting from use, modification, or distribution of this code.