https://github.com/thinknathan/defold-prng
Defold native extension seeded psuedo-random number generator using the Mulberry32 method.
https://github.com/thinknathan/defold-prng
defold defold-extension defold-game-engine defold-library defold-native-extension gamedev
Last synced: about 1 month ago
JSON representation
Defold native extension seeded psuedo-random number generator using the Mulberry32 method.
- Host: GitHub
- URL: https://github.com/thinknathan/defold-prng
- Owner: thinknathan
- License: cc0-1.0
- Created: 2023-05-31T01:25:15.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T16:08:57.000Z (3 months ago)
- Last Synced: 2025-04-20T23:32:34.819Z (about 2 months ago)
- Topics: defold, defold-extension, defold-game-engine, defold-library, defold-native-extension, gamedev
- Language: C++
- Homepage:
- Size: 226 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mulberry32 PRNG for Defold
[](https://github.com/thinknathan/defold-prng/actions/workflows/bob.yml) 
This Defold native extension implements a seeded psuedo-random number generator using the Mulberry32 method.
## Usage
```lua
-- Set the seed. Must be an integer.
prng.set_seed(12345)
-- Generate a random float between 0 and 1.
local randomFloat = prng.rand_float()
-- Generate a random integer between 0 and the maximum you provide.
local randomInt = prng.rand_int(5)
-- Flips a coin. Returns 0 or 1.
local coinFlip = prng.coin()
-- Get a card suit. Returns 0, 1, 2, or 3.
local randomCardSuit = prng.suit()
-- Roll one or more dice.
local dice = prng.dice(1, 8)
-- Rolls twice and takes the higher result. More likely to return 1 than 0.
local success = prng.advantage()
-- Rolls twice and takes the lower result. More likely to return 0 than 1.
local success = prng.disadvantage()
```
## Installation
1. Edit game.project
2. Add dependency `https://github.com/thinknathan/defold-prng/archive/main.zip` for the current version
- Or add a specific [release](https://github.com/thinknathan/defold-prng/releases)
### TypeScript Definitions
This extension includes types for use with [TypeScript + Defold](https://ts-defold.dev/).
1. Install these types
```bash
yarn add git+https://[email protected]/thinknathan/defold-prng.git#^1.0.0 -D
# or
npm install git+https://[email protected]/thinknathan/defold-prng.git#^1.0.0 --save-dev
```
2. Add `defold-prng` to `types` in `tsconfig.json`
```diff
{
"compilerOptions": {
"types": [
+ "defold-prng",
],
}
}
```
3. Add `node_modules/@types` to `typeRoots` in `tsconfig.json` if it's not already there
```diff
{
"compilerOptions": {
"typeRoots": [
+ "node_modules/@types",
],
}
}
```
## Alternatives
See [SplitMix64](https://github.com/indiesoftby/defold-splitmix64), [PCG Random](https://github.com/selimanac/defold-random) and [rand16](https://github.com/wmc7n/rand16). Compare [PRNG implementations](https://github.com/bryc/code/blob/master/jshash/PRNGs.md).