diff --git a/DOCS.md b/DOCS.md
new file mode 100644
index 0000000..f318b59
--- /dev/null
+++ b/DOCS.md
@@ -0,0 +1,43 @@
+# Achievements Lib
+
+## 1. Achievements: structure
+`achievements` is a big table taking mod names as a key and a table as a value. This table can contain whatever entry you like (`name`, `img`, `idontknow`), because the only thing that matters to it is to check whether something exists at the given index. In fact, the following examples are all correct:
+```
+local achievements = {
+ [1] = "inhale",
+ [2] = "exhale"
+}
+
+local achievements = {
+ [1] = { name = "inhale", img = "mod_inhale.png" },
+ [2] = { name = "exhale", img = "mod_exhale.png" }
+}
+
+-- pretty useless but hey ¯\_(ツ)_/¯
+local achievements = {
+ [1] = true,
+ [2] = true
+}
+```
+
+The table is _not_ saved into the storage, only players progress is.
+
+## 2. Registering and unlocking achievements
+In order to register the achievements of a mod, do:
+`achievements_lib.register_achievements(mod, mod_achievements)`
+where `mod` is the mod name and `mod_achievements` a table containing whatever value you want.
+
+On the contrary, to unlock an achievement:
+`achievements_lib.unlock_achievement(p_name, mod, achvmt_ID)`
+
+### 2.1 Utils
+`achievements_lib.has_player_achievement(p_name, mod, achvmt_ID)`: check whether a player has unlocked an achievement
+`achievements_lib.is_player_in_storage(p_name, mod)`: check whether a player has connected after a new mod supporting achievements_lib has been added
+`achievements_lib.add_player_to_storage(p_name, mod)`: for internal use only
+
+### 2.2 Getters
+`achievements_lib.get_achievement(mod, achvmt_ID)`: returns the value assigned to the achievement at the corresponding `achvmt_ID`, if any
+`achievements_lib.get_player_achievements(p_name, mod)`: returns a table containing all the achievements unlocked by `p_name`, where entries are in the format `ID = true`
+
+## 3 About the author
+I'm Zughy (Marco), a professional Italian pixel artist who fights for FOSS and digital ethics. If this library spared you a lot of time and you want to support me somehow, please consider donating on [LiberaPay](https://liberapay.com/Zughy/).
diff --git a/README.md b/README.md
index 1280322..9de1ed3 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,15 @@
Achievements API for Minetest
-S4 League inspired shooter minigame for Minetest.
+
-
+### DOCS
+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/achievements_lib/-/blob/master/DOCS.md).
-(I'll write a documentation as soon as I have time)
\ No newline at end of file
+### Dependencies
+---
+
+### Want to help?
+Feel free to:
+* open an [issue](https://gitlab.com/zughy-friends-minetest/achievements_lib/-/issues)
+* submit a merge request. In this case, PLEASE, do follow milestones and my [coding guidelines](https://cryptpad.fr/pad/#/2/pad/view/-l75iHl3x54py20u2Y5OSAX4iruQBdeQXcO7PGTtGew/embed/). I won't merge features for milestones that are different from the upcoming one (if it's declared), nor messy code
diff --git a/api.lua b/api.lua
index 817ec17..5415fa4 100644
--- a/api.lua
+++ b/api.lua
@@ -11,7 +11,6 @@ local function update_storage() end
local storage = minetest.get_mod_storage()
local achievements = {} -- KEY: mod; VALUE: {KEY: achievement ID; VALUE: {whatever properties}
local p_achievements = {} -- KEY: p_name; VALUE: {KEY: mod, VALUE: {KEY: achievement ID VALUE: true/nil}}}
-local access_keys = {} -- KEY: random ID; VALUE: mod name
-- inizializzo storage caricando tutti i giocatori
@@ -33,7 +32,7 @@ end
-function achievements_lib.add_achievement(p_name, mod, achvmt_ID)
+function achievements_lib.unlock_achievement(p_name, mod, achvmt_ID)
local achievement = achievements[mod][achvmt_ID]
@@ -79,17 +78,20 @@ function achievements_lib.add_player_to_storage(p_name, mod)
minetest.log("Warning", "[ACHIEVEMENTS_LIB] Player " .. p_name .. " must be online in order to be added to the storage!")
return end
- if p_achievements[p_name] then
- if mod and p_achievements[p_name][mod] then
- minetest.log("Warning", "[ACHIEVEMENTS_LIB] Can't add player to storage, an entry within this mod already exists!")
- elseif mod then
- p_achievements[p_name][mod] = {}
- storage:set_string(p_name, minetest.serialize(p_achievements[p_name]))
- else
- minetest.log("Warning", "[ACHIEVEMENTS_LIB] Can't add player to storage, an entry already exists!")
- end
- else
+ if not p_achievements[p_name] then
p_achievements[p_name] = {}
+ end
+
+ local update_storage = false
+
+ for mod, _ in achievements do
+ if not achievements_lib.is_player_in_storage(p_name, mod) then
+ p_achievements[p_name][mod] = {}
+ update_storage = true
+ end
+ end
+
+ if update_storage then
storage:set_string(p_name, minetest.serialize(p_achievements[p_name]))
end
end
@@ -123,3 +125,16 @@ end
function update_storage(p_name)
storage:set_string(p_name, minetest.serialize(p_achievements[p_name]))
end
+
+
+
+
+
+----------------------------------------------
+------------------DEPRECATED------------------
+----------------------------------------------
+
+function achievements_lib.add_achievement(p_name, mod, achvmt_ID)
+ minetest.log("warning", "[ACHIEVEMENTS_LIB] (" .. mod .. ") achievements_lib.add_achievement is deprecated: use unlock_achievement instead")
+ achievements_lib.unlock_achievement(p_name, mod, achvmt_ID)
+end
diff --git a/player_manager.lua b/player_manager.lua
index 603baa5..ed7ed54 100644
--- a/player_manager.lua
+++ b/player_manager.lua
@@ -1,3 +1,3 @@
-minetest.register_on_newplayer(function(ObjectRef)
- achievements_lib.add_player_to_storage(ObjectRef:get_player_name())
+minetest.register_on_joinplayer(function(player)
+ achievements_lib.add_player_to_storage(player:get_player_name())
end)