Download the PHP package nabeghe/levex without Composer

On this page you can find all versions of the php package nabeghe/levex. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of nabeghe/levex

Informations about the package levex

Levex (Level + Experience)

A simple leveling and XP System for PHP, Just Like in Online Games.

Building a leveling system that showcases a user's level based on their experience points might seem like a daunting task. But fear not! Levex simplifies this process with just a few straightforward methods. You can effortlessly implement this functionality without diving into complex calculations. Enjoy a seamless experience as you elevate your users’ journey!

🫡 Usage

🚀 Installation

You can install the package via composer:

Instance

Default Instance

Retrieve a singleton instance with default options:

Custom Instance

Retrieve a custom instance with custom options:

Options are related to class fields:

Name Description
baseLevelXp XP required to reach level 1. Default 100.
levelLogBase Logarithmic base in calculating the level by XP. Default 3.
priceXpRate XP rate per unit of price. For example, if the rate is 10, every 10 units of a specified price will equal 1 XP. Default 1.
godLevelSymbols Symbols that indicate a level associated with the creator or God, rather than a regular level. Default ['∞'].
negativeLevelIsGod Indicates whether a negative level should be considered as the god/creator or not. Default true.
levelNamesHandler A callable that acts as a replacement for the determineLevelName method and takes the same input. If determineLevelName returns null, the main method will be executed. Used to customize the name/title of levels. Default null.

Global Configuration

use kyeword const or function define.

Name Description
LEVEX_BASE_LEVEL_XP related to $levex->baseLevelXp
LEVEX_LEVEL_LOG_BASE related to $levex->levelLogBase
LEVEX_PRICE_XP_RATE related to $levex->priceXpRate
LEVEX_GOD_LEVEL_SYMBOLS related to $levex->godLevelSymbols
LEVEX_NEGATIVE_LEVEL_IS_GOD related to $levex->negativeLevelIsGod

Methods

calcLevel(int $xp): int

Calculates which level corresponds to a given XP.

calcRequiredXpToLevel(int $level): int

Calculates the minimum XP required to reach a specified level.

calcRemainingXpToLevel(int $level, $currentXP, &levelXP = null): int

Calculates how much XP is remaining to reach a specific level.

Notice: The $levelXP is output of the calcRequiredXpToLevel()

calcRemainingPercentToLevel(int $level, int $currentXP, int &$leftXP = 0): float|int

Calculates how many percent of progress reamining to reaching a specific level.

Notice: The $levelXP is output of the remaining XP to reach the desired level.

calcPassedPercentToLevel(int $level, int $currentXP, int &$leftXP = 0): float|int

Calculates how many percent of progress has been made towards reaching a specific level.

Notice: The $levelXP is output of the remaining XP to reach the desired level.

calcXpByPrice($price, ?float $rate = null): int

Calculates how much XP can be earned from a given price.

Notice: The $rate is XP rate per unit of price. For example, if the rate is 10, every 10 units of a specified price will equal 1 XP. Default is option 'priceXpRate'.

checkGodLevel($level): bool

Checks whether the level is specific to the god or not.

determineLevelName($level): string

Retrives the name/title of a level.

📖 License

Copyright (c) 2024 Hadi Akbarzadeh

Licensed under the MIT license, see LICENSE.md for details.

All versions of levex with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package nabeghe/levex contains the following files

Loading the files please wait ....