arena_lib/README.md

# 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 :*

<a href="https://liberapay.com/EticaDigitale/donate"><img src="https://i.imgur.com/4B2PxjP.png" alt="Support my work"/></a>  

### 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) **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).  

### Dependencies
Default  
[signs_lib](https://gitlab.com/VanessaE/signs_lib) by Vanessa Dannenberg  

### Known conflicts
`Beds` or any other mod overriding the default respawn system  

#### Mods relying on arena_lib
[Murder](https://gitlab.com/giov4/minetest-murder-mod)  
[Quake](https://gitlab.com/zughy-friends-minetest/minetest-quake)