From 058665d4767de02ed4e144066734733e281509a9 Mon Sep 17 00:00:00 2001 From: Marco <4279489-marco_a@users.noreply.gitlab.com> Date: Thu, 16 Apr 2020 15:56:54 +0200 Subject: [PATCH] Update README.md --- README.md | 21 +++------------------ 1 file changed, 3 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index b700d99..4a6674f 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,15 @@ # Arena_lib Arena_lib is a library for Minetest working as a core for any arena minigame you have in mind. -It comes with an arena manager and a signs system. The latter creates a bridge inside your own server between the hub and your actual mod (deathmatch, capture the flag, assault, you name it). In other words, you don't have to do the boring job and you can focus exclusively on your minigame :* +It comes with an arena manager and a signs system. The latter creates a bridge inside your own server between the hub and your actual mod (deathmatch, capture the flag, assault, you name it). In other words, you don't have to do the boring job and you can focus exclusively on your minigame(s) :* Support my work ### Config -> BEWARE! Arena_lib right now works with a minigame only. DO NOT use it for more than one mod in the same client/server or it'll override itself over and over. We're on it to fix it +1) Install it as any other mod -1) **You DON'T need to create a different folder in your mods path.** Instead, create a folder called `arena_lib` inside your specific mod folder and put all the files of this repo there (mind the textures!). - -2) Add this in your init.lua -`dofile(minetest.get_modpath("YOURMODNAME") .. "/arena_lib/api.lua")` - -3) You can customize the lib calling - -``` -arena_lib.settings({ - prefix = "[whatever] " - --other parameters -}) -``` -in your init.lua. - -4) 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) 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