fakelib/README.md

# Minetest fake userdata library [fakelib]

[![luacheck](https://github.com/OgelGames/fakelib/workflows/luacheck/badge.svg)](https://github.com/OgelGames/fakelib/actions)
[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE.md)
[![Minetest](https://img.shields.io/badge/Minetest-5.0+-blue.svg)](https://www.minetest.net)
[![ContentDB](https://content.minetest.net/packages/OgelGames/fakelib/shields/downloads/)](https://content.minetest.net/packages/OgelGames/fakelib/)

## Overview

This mod is a code library for creating fake userdata (players, inventories and metadata), replicating their functionality as closely as possible.

## Usage

Simply add `fakelib` to your mod's dependencies, and call any of the API functions from your code.

See [API.md](API.md) for detailed documentation.

## Installation

Download the [master branch](https://github.com/OgelGames/fakelib/archive/master.zip) or the [latest release](https://github.com/OgelGames/fakelib/releases), and follow [the usual installation steps](https://wiki.minetest.net/Installing_Mods).

Alternatively, you can download and install the mod from [ContentDB](https://content.minetest.net/packages/OgelGames/fakelib) or the online content tab in Minetest.

## License

All code is licensed under the [MIT License](LICENSE).