Skip to content

add syntax highlighting to readme #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
amilajack wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add syntax highlighting to readme #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,37 @@ Mostly packaged so I can easily include it in my projeccts. Nothing more
JavaScript's Math.random() is fast, but has problems. First, it isn't seedable, second, its randomness leaves a bit to be desired. [Johannes Baagøe](http://baagoe.org/) has done some great work in trying to find a more modern PRNG algorithm that performs well on JavaScript, and Alea seems to be the one that has come out ahead ([benchmarks](http://jsperf.com/prng-comparison)).

## Installation

npm install alea
```bash
npm install alea
```

## Usage
```js
var Alea = require('alea')

var Alea = require('alea')

var prng = new Alea() // add an optional seed param
var prng = new Alea() // add an optional seed param

var nextRandnum = prng() // just call the return value of Alea
var nextRandnum = prng() // just call the return value of Alea
```

## Additions

Also adds the ability to sync up two Alea PRNGs via the importState and exportState methods.
```js
var prng1 = new Alea(200)

var prng1 = new Alea(200)

prng1()
prng1()
prng1()
prng1()

// after generating a few random numbers, we will initialize a new PRNG
// after generating a few random numbers, we will initialize a new PRNG

var prng2 = Alea.importState(prng1.exportState())
var prng2 = Alea.importState(prng1.exportState())

// this should echo true, true, true
console.log(prng2() == prng1())
console.log(prng2() == prng1())
console.log(prng2() == prng1())
// this should echo true, true, true
console.log(prng2() == prng1())
console.log(prng2() == prng1())
console.log(prng2() == prng1())
```

The theory behind this is that while a server is running a simulation (for example, a game) and clients connect to the server, each client will run its own simulation without having to depend 100% on the server for every update of the simulation state. By importing the current generator state from the server, a client can join in at any time and have an accurate simulation fully in sync with the server.

Expand Down