Schedule1 Mixer

Installation

# npm
npm install @schedule1-tools/mixer
# yarn
yarn add @schedule1-tools/mixer
# pnpm
pnpm add @schedule1-tools/mixer

Quick Start

1. Calculate a mix

import { mixSubstances } from '@schedule1-tools/mixer';
/**
 * mixSubstances(product: Product, substances: Substance[])
 * → computes cost, effects, profit, profitMargin, addiction
 */
const result = mixSubstances('OG Kush', ['Cuke', 'Flu Medicine', 'Gasoline']);
// result → {
// effects: ['Be','Se','Eu','To'],
// cost: 12,
// sellPrice: 64,
// profit: 52,
// profitMargin: 0.81,
// addiction: 0.44
// }

2. Calculate from a hash

import { mixFromHash } from '@schedule1-tools/mixer';
/**
 * mixFromHash(hash: string)
 * → decode & compute a mix from its shared hash form
 */
const result = mixFromHash('T0cgS3VzaDpBQkM');
// result → {
// effects: ['Be','Se','Eu','To'],
// cost: 12,
// sellPrice: 64,
// profit: 52,
// profitMargin: 0.81,
// addiction: 0.44
// }

3. Encode & decode mix state

import { decodeMixState, encodeMixState } from '@schedule1-tools/mixer';
/**
 * encodeMixState(state: MixState) → string
 * decodeMixState(hash: string) → MixState
 */
const encoded = encodeMixState({
 product: 'OG Kush',
 substances: ['Cuke', 'Flu Medicine', 'Gasoline'],
});
// encoded → 'T0cgS3VzaDpBQkM'
const decoded = decodeMixState(encoded);
// decoded → { product: 'OG Kush', substances: [...] }

4. Migrate an old mix hash

import { migrateMixHash } from '@schedule1-tools/mixer';
/**
 * migrateMixHash(legacyHash: string): Promise<string|null>
 * → upgrade legacy LZ‐String hash to the new format
 */
const newHash = await migrateMixHash('OLD_BASE64_HASH_HERE');
// newHash → 'T0cgS3VzaDpBQkM' (or null if invalid)

Exports

import { effectRulesBySubstance, effects, products, substances } from '@schedule1-tools/mixer';

Contributing

License

Notice