game-difficult-coefficient-calculator v1.0.4

Game Difficult Coefficient Calculator

A utility function for calculating the difficulty coefficient in games based on the player's progress and a customizable set of parameters. This function normalizes the current progress and computes a difficulty value using an adjustable growth factor, linear coefficient, and rounding precision.

Installation

You can install this package via npm:

npm i game-difficult-coefficient-calculator

Usage

Import the function

You can import the function into your project as follows:

import { GameDifficultCoefCalculate }
   from 'game-difficult-coefficient-calculator';

Syntax

GameDifficultCoefCalculate(curValue, maxValue = 100, growthFactor = 1, linearCoeff = 0.5, roundTo = 2)

Parameters

Return Value

The function returns a number representing the calculated difficulty coefficient, rounded to the specified decimal precision.

Example

const { GameDifficultCoefCalculate } = require('game-difficult-coef-calculate');

// Example 1: Basic usage with default parameters
const difficulty1 = GameDifficultCoefCalculate(30);
console.log(difficulty1); // Output: A calculated difficulty coefficient

// Example 2: Custom parameters
const difficulty2 = GameDifficultCoefCalculate(75, 150, 5, 0.8, 3);
console.log(difficulty2); // Output: A calculated difficulty coefficient with 3 decimal precision

How It Works

1. Normalize Progress: The function normalizes the current progress value (curValue) relative to the maximum value (maxValue).
2. Difficulty Calculation: Combines:
   • A linear growth term scaled by growthFactor.
   • An exponential growth term adjusted by linearCoeff.
3. Round to Precision: The result is rounded to the specified number of decimal places using the roundTo parameter.

Formula

The difficulty coefficient is calculated using the following formula:

difficultyCoefficient =
   1 + normalizedExperience * growthFactor
   + (Math.exp(growthFactor * normalizedExperience) - 1)
   * linearCoeff

Where:

• normalizedExperience = curValue / maxValue

Why Use This?

This function is ideal for games that need a dynamic and scalable difficulty progression. It can adapt difficulty based on player experience, skill levels, or other metrics, allowing for more engaging and balanced gameplay.

License

This project is licensed under the MIT License. See the LICENSE file for details.