From 509109a544bc9890d8f6bad8fa6154656daab8d1 Mon Sep 17 00:00:00 2001 From: Zughy <4279489-marco_a@users.noreply.gitlab.com> Date: Sun, 8 Nov 2020 17:48:16 +0100 Subject: [PATCH] README/DOCS: LuaJIT notice --- DOCS.md | 4 ++-- README.md | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/DOCS.md b/DOCS.md index a414882..0825a89 100644 --- a/DOCS.md +++ b/DOCS.md @@ -179,9 +179,9 @@ Overriding these functions is **not** recommended. Instead, there are 4 respecti > Still a TL;DR? Check out the [example file](mod-init.lua.example) -First of all download the mod and put it in your mods folder. +First of all download the mod and put it in your mods folder. Then, be sure you have [LuaJIT](https://luajit.org/) installed on your machine. -Then, you need to register your minigame in arena_lib, possibly inside the init.lua, via: +Now you need to register your minigame in arena_lib, possibly inside the init.lua, via: ``` arena_lib.register_minigame("yourmod", {parameter1, parameter2 etc}) ``` diff --git a/README.md b/README.md index a67ba1d..3cfbd41 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,9 @@ It comes with an arena manager and a signs system. The latter creates a bridge i 1) Install it as any other mod -2) For an in-depth understanding of what you can do with the library, have a look at the [full documentation](https://gitlab.com/zughy-friends-minetest/arena_lib/-/blob/master/DOCS.md). +2) Be sure you have [LuaJIT](https://luajit.org/) installed on your machine + +3) For an in-depth understanding of what you can do with the library, have a look at the [full documentation](https://gitlab.com/zughy-friends-minetest/arena_lib/-/blob/master/DOCS.md). ### Dependencies Default