mtcontrib/fakelib
1
0
Fork 0
mirror of https://github.com/OgelGames/fakelib.git synced 2024-11-14 07:50:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
OgelGames 2024-05-15 19:55:19 +10:00
parent e6ed62e939
commit a7b0160ad2
2 changed files with 25 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,2 +1,24 @@
# fakelib
Minetest userdata imitation library
# 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)
## 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).
## License
All code is licensed under the [MIT License](LICENSE).

2
mod.conf
View File

@ -1,3 +1,3 @@
name = fakelib
description = Minetest userdata imitation library
description = Minetest fake userdata library
min_minetest_version = 5.0