Mirrorlandia_minetest/playerfactions
1
0
Fork 0
mirror of https://github.com/mt-mods/playerfactions.git synced 2024-11-22 15:23:47 +01:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Basile 2020-07-29 10:41:40 +00:00
parent 0b799f3c5f
commit 1eae826e00
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -6,7 +6,7 @@ A simple mod which allows player created factions. Not very useful on its own, i
We can choose a mode : single or multi factions. We can choose a mode : single or multi factions.
By default the mod is single faction, if we want to change, all it takes is to add a line `mode_unique_faction = false` into the mod.conf file By default the mod is single faction, if we want to change, all it takes is to add a line `mode_unique_faction = false` into the mod.conf file
Below, parameters with [] are useful only with the multi-factions mode. Below, parameters with [ ] are useful only with the multi-factions mode.
There is an admin privs to enable every functions for every faction : playerfactions_admin There is an admin privs to enable every functions for every faction : playerfactions_admin
@ -50,11 +50,12 @@ Additionally, `playerfactions` can optionally depend on the following mods:
I strongly recommend reading through the `init.lua` file; the functions at the top give you a pretty good idea of how to use it, but just in case you're short on time I'll list the most important functions below. I strongly recommend reading through the `init.lua` file; the functions at the top give you a pretty good idea of how to use it, but just in case you're short on time I'll list the most important functions below.
- `factions.version` is a variable made to check the version of the playerfactions mod to assert compatibility: - `factions.version` is a variable made to check the version of the playerfactions mod to assert compatibility:
* factions.version == nil for firsts version of playerfactions mod ** factions.version == nil for firsts version of playerfactions mod
* factions.version == 2 is the first time this variable is added, with adding multi-faction mode ** factions.version == 2 is the first time this variable is added, with adding multi-faction mode
- `player_is_in_faction(fname, player_name)`: `true` if the player is in the faction, `nil` in other cases (facion or player doesn't exists or player is not a member of the faction) - `player_is_in_faction(fname, player_name)`: `true` if the player is in the faction, `nil` in other cases (facion or player doesn't exists or player is not a member of the faction)
- `get_facts()`: Get the table with all data. The structure is : - `get_facts()`: Get the table with all data. The structure is :
```{["name_of_faction1"]={ ```
{["name_of_faction1"]={
["owner"]=name_of_the_owner, ["owner"]=name_of_the_owner,
["members"]={["name_of_a_member1"]=true, ["name_of_a_member2"]=true} ["members"]={["name_of_a_member1"]=true, ["name_of_a_member2"]=true}
}} }}