mindfuck

Brainfuck interpreter library, node.js module, and command-line tool


Keywords
mindfuck, brainfuck, interpreter, command-line tool, web
License
MIT
Install
npm install mindfuck@0.1.0

Documentation

Mindfuck

Mindfuck is a Brainfuck interperter usable as a node.js module, a command-line tool, and as a web library.

Node.js module

  1. Install node.js and npm.js
  2. Run from your project folder
npm install mindfuck
  1. Or add the following to your package.json
"dependencies": {
	"mindfuck": "0.x"
},
  1. See the Library section for futher usage

Command line

  1. Install node.js and npm.js
  2. Run
npm install mindfuck -g

Commands

Usage:                          fitp [options]
Options:
  -c "<code>", -code "<code>"   runs the given code
  -e <bool>, -error <bool>      stop when encountering an error, default false
  -h, -help                     command options
  -m, -memory                   memory cell length, default 30000
  -p <path>, -path <path>       runs using the the code from the file
  -v, -version                  semantic version

Web

  1. Copy the brainfuck.js file from the lib folder
  2. See the Library section for futher usage
  3. See the example in the example folder

Library

Functions

brainfuck
    Parameter(s): object options
	Parse options to the library, see options
brainfuck.run
	Parameter(s): string code
	Runs the given code

Options

memoryLength
	Default: 30000
	Amount of cells in memory
returnOnError
	Default: false
	Stop when encountering an unknown operation
callbackInput
	Parameter(s): function callback
	Called when input required, call the callback with the input in order to continue the program
callbackOutput
	Parameter(s): char value
	Called when output operation encountered
callbackComplete
	Parameter(s): string error
	Called when program is finished, or an error has been encountered if returnOnError is true

License

MIT license

Contribute

If you have any ideas or see any issues feel free to start a discussion at the issues section.