nalc/awards
1
0
Fork 1
forked from mtcontrib/awards
Code Issues Pull Requests Releases Wiki Activity

Merge remote-tracking branch 'upstream/master'

Browse Source
This commit is contained in:
Sys Quatre 2021-01-12 21:43:50 +01:00
commit c27d527cfc
7 changed files with 154 additions and 117 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@ -37,10 +37,11 @@ awards.register_award("mymod:award", {
The above trigger type is an example of a counted_key trigger: The above trigger type is an example of a counted_key trigger:
rather than a single counter there's a counter per key - in this rather than a single counter there's a counter per key - in this
case the key is the value of the `node` field. If you leave out case the key is the value of the `node` field.
the key in a `counted_key` trigger, then the total will be used
instead. For example, here is an award which unlocks after you've If you leave out the key in a `counted_key` trigger, then the total will be used
placed 10 nodes of any type: instead. For example, here is an award which unlocks after you've placed 10
nodes of any type:
```lua ```lua
awards.register_award("mymod:award", { awards.register_award("mymod:award", {
@ -125,6 +126,10 @@ awards.register_trigger("foo", {
type = "custom", type = "custom",
progress = "@1/@2 foos", progress = "@1/@2 foos",
auto_description = { "Do a foo", "Foo @1 times" }, auto_description = { "Do a foo", "Foo @1 times" },
on_register = function(self, award)
print(award.name .. " was registered with foo trigger type")
end,
}) })
minetest.register_on_foo(function() minetest.register_on_foo(function()
@ -168,7 +173,9 @@ end
# API # API
* awards.register_award(name, def), the def table has the following fields: ## Awards
* `awards.register_award(name, def)`, the def table has the following fields:
* `title` - title of the award (defaults to name) * `title` - title of the award (defaults to name)
* `description` - longer description of the award, displayed in Awards tab * `description` - longer description of the award, displayed in Awards tab
* `difficulty` - see [Award Difficulty](#award-difficulty). * `difficulty` - see [Award Difficulty](#award-difficulty).
@ -178,27 +185,53 @@ end
* `secret` - boolean if this award is secret (i.e. showed on awards list) * `secret` - boolean if this award is secret (i.e. showed on awards list)
* `sound` - `SimpleSoundSpec` table to play on unlock. * `sound` - `SimpleSoundSpec` table to play on unlock.
`false` to disable unlock sound. `false` to disable unlock sound.
* `icon` - the icon image, use default otherwise. * `icon` - the icon image. Defaults to `awards_unknown.png`.
* `background` - the background image, use default otherwise. * `hud_background` - the background image used in the HUD to contain the text and icon.
Defaults to `awards_bg_default.png`.
* `trigger` - trigger definition, see [Builtin Trigger Types](#builtin-trigger-types). * `trigger` - trigger definition, see [Builtin Trigger Types](#builtin-trigger-types).
* `on_unlock(name, def)` - callback on unlock. * `on_unlock(name, def)` - callback on unlock.
* awards.register_trigger(name, def), the def table has the following fields: * `awards.registered_awards` - table of award name to definition.
* `type` - see [Trigger Types](#trigger-types). * `awards.register_on_unlock(func(name, def))`
* `name` is the player name
* `def` is the award def.
* return true to cancel HUD from appearing.
* `awards.unlock(player_name, award_name)`
* gives an award to a player
* `awards.get_award_states(player_name)`
* Returns list of tables, sorted by `score`, each having the fields:
```lua
{
name = "mymod:awardname",
def = {}, -- Award definition
unlocked = true, -- Whether award has been unlocked
started = true, -- Whether any progress has been made
score = 0, -- Score used in sorting
-- Either a table or nil
-- Will be nil if progress is indeterminable or
-- if the award is unlocked
progress = {
current = 5,
target = 10,
label = "label", -- Label to show over progress bar
}
}
```
## Triggers
* `awards.register_trigger(name, def)`, the def table has the following fields:
* `type` - see trigger type types in [Trigger Types](#trigger-types).
* `progress` - used to format progress, defaults to "%1/%2". * `progress` - used to format progress, defaults to "%1/%2".
* `auto_description` - a table of two elements. Each element is a format string. Element 1 is singular, element 2 is plural. Used for the award description (not title) if none is given. * `auto_description` - a table of two elements. Each element is a format string. Element 1 is singular, element 2 is plural. Used for the award description (not title) if none is given.
* `on_register(award_def)` - called when an award registers with this type. * `on_register(self, award_def)` - called when an award registers with this type.
* "counted_key" only: * "counted_key" only:
* `auto_description_total` - Used if the trigger is for the total. * `auto_description_total` - Used if the trigger is for the total.
* `get_key(self, def)` - get key for particular award, return nil for a total. * `get_key(self, def)` - get key for particular award, return nil for a total.
* `key_is_item` - true if the key is an item name. On notify(), * `key_is_item` - true if the key is an item name. On notify(),
any watched groups will also be notified as `group:groupname` keys. any watched groups will also be notified as `group:groupname` keys.
* awards.register_on_unlock(func(name, def)) * `awards.registered_triggers` - table of trigger name to definition.
* name is the player name
* def is the award def.
* return true to cancel HUD
* awards.unlock(name, award)
* gives an award to a player
* name is the player name
## Builtin Trigger Types ## Builtin Trigger Types

2
init.lua
View File

@ -3,7 +3,9 @@
-- The global award namespace -- The global award namespace
awards = { awards = {
show_mode = "hud", show_mode = "hud",
registered_awards = {},
registered_triggers = {}, registered_triggers = {},
on_unlock = {},
} }
-- Internationalization support. -- Internationalization support.

70
src/api_awards.lua
View File

@ -95,7 +95,7 @@ function awards.unlock(name, award)
-- Get Notification Settings -- Get Notification Settings
local title = awdef.title or award local title = awdef.title or award
local desc = awdef.description or "" local desc = awdef.description or ""
local background = awdef.background or "awards_bg_default.png" local background = awdef.hud_background or awdef.background or "awards_bg_default.png"
local icon = (awdef.icon or "awards_unknown.png") .. "^[resize:32x32" local icon = (awdef.icon or "awards_unknown.png") .. "^[resize:32x32"
local sound = awdef.sound local sound = awdef.sound
if sound == nil then if sound == nil then
@ -185,3 +185,71 @@ function awards.unlock(name, award)
end) end)
end end
end end
function awards.get_award_states(name)
local hash_is_unlocked = {}
local retval = {}
-- Add all unlocked awards
local data = awards.player(name)
if data and data.unlocked then
for awardname, _ in pairs(data.unlocked) do
local def = awards.registered_awards[awardname]
if def then
hash_is_unlocked[awardname] = true
local score = -100000
local difficulty = def.difficulty or 1
if def.trigger and def.trigger.target then
difficulty = difficulty * def.trigger.target
end
score = score + difficulty
retval[#retval + 1] = {
name = awardname,
def = def,
unlocked = true,
started = true,
score = score,
progress = nil,
}
end
end
end
-- Add all locked awards
for _, def in pairs(awards.registered_awards) do
if not hash_is_unlocked[def.name] and def:can_unlock(data) then
local progress = def.get_progress and def:get_progress(data)
local started = false
local score = def.difficulty or 1
if def.secret then
score = 1000000
elseif def.trigger and def.trigger.target and progress then
local perc = progress.current / progress.target
score = score * (1 - perc) * def.trigger.target
if perc < 0.001 then
score = score + 100
else
started = true
end
else
score = 100
end
retval[#retval + 1] = {
name = def.name,
def = def,
unlocked = false,
started = started,
score = score,
progress = progress,
}
end
end
table.sort(retval, function(a, b)
return a.score < b.score
end)
return retval
end

16
src/api_triggers.lua
View File

@ -2,9 +2,7 @@
local S, NS = awards.gettext, awards.ngettext local S, NS = awards.gettext, awards.ngettext
awards.registered_awards = {}
awards.on = {} awards.on = {}
awards.on_unlock = {}
local default_def = {} local default_def = {}
@ -43,11 +41,12 @@ function awards.register_trigger(tname, tdef)
} }
tdef.register(tmp) tdef.register(tmp)
function def.getProgress(_, data) function def.get_progress(_, data)
local done = math.min(data[tname] or 0, tmp.target) local current = math.min(data[tname] or 0, tmp.target)
return { return {
perc = done / tmp.target, current = current,
label = S(tdef.progress, done, tmp.target), target = tmp.target,
label = S(tdef.progress, current, tmp.target),
} }
end end
@ -102,7 +101,7 @@ function awards.register_trigger(tname, tdef)
end end
-- Called to get progress values and labels -- Called to get progress values and labels
function def.getProgress(_, data) function def.get_progress(_, data)
data[tname] = data[tname] or {} data[tname] = data[tname] or {}
local done local done
@ -114,7 +113,8 @@ function awards.register_trigger(tname, tdef)
done = math.min(done, tmp.target) done = math.min(done, tmp.target)
return { return {
perc = done / tmp.target, current = done,
target = tmp.target,
label = S(tdef.progress, done, tmp.target), label = S(tdef.progress, done, tmp.target),
} }
end end

30
src/awards.lua
View File

@ -251,7 +251,7 @@ if minetest.get_modpath("default") then
title = S("Lava and Water"), title = S("Lava and Water"),
description = S("Mine your first obsidian."), description = S("Mine your first obsidian."),
icon = "awards_lava_and_water.png^awards_level1.png", icon = "awards_lava_and_water.png^awards_level1.png",
background = "awards_bg_mining.png", hud_background = "awards_bg_mining.png",
difficulty = 1.5, difficulty = 1.5,
trigger = { trigger = {
type = "dig", type = "dig",
@ -265,7 +265,7 @@ if minetest.get_modpath("default") then
title = S("Obsessed with Obsidian"), title = S("Obsessed with Obsidian"),
description = S("Mine 50 obsidian."), description = S("Mine 50 obsidian."),
icon = "awards_obsessed_with_obsidian.png^awards_level2.png", icon = "awards_obsessed_with_obsidian.png^awards_level2.png",
background = "awards_bg_mining.png", hud_background = "awards_bg_mining.png",
difficulty = 1.5, difficulty = 1.5,
trigger = { trigger = {
type = "dig", type = "dig",
@ -279,7 +279,7 @@ if minetest.get_modpath("default") then
title = S("Lava Miner"), title = S("Lava Miner"),
description = S("Mine any block while being very close to lava."), description = S("Mine any block while being very close to lava."),
icon = "awards_lava_miner.png", icon = "awards_lava_miner.png",
background = "awards_bg_mining.png", hud_background = "awards_bg_mining.png",
difficulty = 1, difficulty = 1,
}) })
awards.register_on_dig(function(player,data) awards.register_on_dig(function(player,data)
@ -386,7 +386,7 @@ if minetest.get_modpath("default") then
title = S("First Mese Find"), title = S("First Mese Find"),
description = S("Mine your first mese ore."), description = S("Mine your first mese ore."),
icon = "awards_first_mese_find.png", icon = "awards_first_mese_find.png",
background = "awards_bg_mining.png", hud_background = "awards_bg_mining.png",
difficulty = 1, difficulty = 1,
trigger = { trigger = {
type = "dig", type = "dig",
@ -401,7 +401,7 @@ if minetest.get_modpath("default") then
title = S("Mese Mastery"), title = S("Mese Mastery"),
description = S("Mine a mese block."), description = S("Mine a mese block."),
icon = "awards_mese_mastery.png", icon = "awards_mese_mastery.png",
background = "awards_bg_mining.png", hud_background = "awards_bg_mining.png",
difficulty = 1.1, difficulty = 1.1,
trigger = { trigger = {
type = "dig", type = "dig",
@ -415,7 +415,7 @@ if minetest.get_modpath("default") then
title = S("You’re a copper"), title = S("You’re a copper"),
description = S("Dig 1,000 copper ores."), description = S("Dig 1,000 copper ores."),
icon = "awards_youre_a_copper.png", icon = "awards_youre_a_copper.png",
background = "awards_bg_mining.png", hud_background = "awards_bg_mining.png",
difficulty = 0.2, difficulty = 0.2,
trigger = { trigger = {
type = "dig", type = "dig",
@ -429,7 +429,7 @@ if minetest.get_modpath("default") then
title = S("Mini Miner"), title = S("Mini Miner"),
description = S("Dig 100 stone blocks."), description = S("Dig 100 stone blocks."),
icon = "awards_mini_miner.png^awards_level1.png", icon = "awards_mini_miner.png^awards_level1.png",
background = "awards_bg_mining.png", hud_background = "awards_bg_mining.png",
difficulty = 0.02, difficulty = 0.02,
trigger = { trigger = {
type = "dig", type = "dig",
@ -443,7 +443,7 @@ if minetest.get_modpath("default") then
title = S("Hardened Miner"), title = S("Hardened Miner"),
description = S("Dig 1,000 stone blocks."), description = S("Dig 1,000 stone blocks."),
icon = "awards_hardened_miner.png^awards_level2.png", icon = "awards_hardened_miner.png^awards_level2.png",
background = "awards_bg_mining.png", hud_background = "awards_bg_mining.png",
difficulty = 0.02, difficulty = 0.02,
trigger = { trigger = {
type = "dig", type = "dig",
@ -457,7 +457,7 @@ if minetest.get_modpath("default") then
title = S("Master Miner"), title = S("Master Miner"),
description = S("Dig 10,000 stone blocks."), description = S("Dig 10,000 stone blocks."),
icon = "awards_master_miner.png^awards_level3.png", icon = "awards_master_miner.png^awards_level3.png",
background = "awards_bg_mining.png", hud_background = "awards_bg_mining.png",
difficulty = 0.02, difficulty = 0.02,
trigger = { trigger = {
type = "dig", type = "dig",
@ -471,7 +471,7 @@ if minetest.get_modpath("default") then
title = S("Marchand De Sable"), title = S("Marchand De Sable"),
description = S("Dig 1,000 sand."), description = S("Dig 1,000 sand."),
icon = "awards_marchand_de_sable.png", icon = "awards_marchand_de_sable.png",
background = "awards_bg_mining.png", hud_background = "awards_bg_mining.png",
difficulty = 0.05, difficulty = 0.05,
trigger = { trigger = {
type = "dig", type = "dig",
@ -581,7 +581,7 @@ if minetest.get_modpath("default") then
title = S("First Gold Find"), title = S("First Gold Find"),
description = S("Mine your first gold ore."), description = S("Mine your first gold ore."),
icon = "awards_first_gold_find.png^awards_level1.png", icon = "awards_first_gold_find.png^awards_level1.png",
background = "awards_bg_mining.png", hud_background = "awards_bg_mining.png",
difficulty = 0.9, difficulty = 0.9,
trigger = { trigger = {
type = "dig", type = "dig",
@ -594,7 +594,7 @@ if minetest.get_modpath("default") then
title = S("Gold Rush"), title = S("Gold Rush"),
description = S("Mine 45 gold ores."), description = S("Mine 45 gold ores."),
icon = "awards_gold_rush.png^awards_level2.png", icon = "awards_gold_rush.png^awards_level2.png",
background = "awards_bg_mining.png", hud_background = "awards_bg_mining.png",
difficulty = 0.9, difficulty = 0.9,
trigger = { trigger = {
type = "dig", type = "dig",
@ -619,7 +619,7 @@ if minetest.get_modpath("default") then
title = S("Girl's Best Friend"), title = S("Girl's Best Friend"),
description = S("Mine 18 diamond ores."), description = S("Mine 18 diamond ores."),
icon = "awards_girls_best_friend.png^awards_level2.png", icon = "awards_girls_best_friend.png^awards_level2.png",
background = "awards_bg_mining.png", hud_background = "awards_bg_mining.png",
difficulty = 1, difficulty = 1,
trigger = { trigger = {
type = "dig", type = "dig",
@ -1090,7 +1090,7 @@ if minetest.get_modpath("mesecons") then
difficulty = 0.2, difficulty = 0.2,
trigger = { trigger = {
type = "place", type = "place",
node = "pipeworks:tube_1", node = "mesecons:wire_00000000_off",
target = 500, target = 500,
} }
}) })
@ -1099,7 +1099,7 @@ end
if minetest.get_modpath("basic_materials") then if minetest.get_modpath("basic_materials") then
awards.register_award("awards_oil", { awards.register_award("awards_oil", {
title = S("Oil Typhoon"), title = S("Oil Typhoon"),
description = S("Craft 100 times flint and steel."), description = S("Craft 500 times oil extract."),
trigger = { trigger = {
type = "craft", type = "craft",

3
src/data.lua
View File

@ -80,7 +80,8 @@ function awards.load()
os.rename(old_save_path, minetest.get_worldpath().."/awards.bk.txt") os.rename(old_save_path, minetest.get_worldpath().."/awards.bk.txt")
awards.save() awards.save()
else else
__player_data = minetest.parse_json(storage:get_string("player_data")) or {} local json = storage:get("player_data")
__player_data = json and minetest.parse_json(json) or {}
end end
end end

83
src/gui.lua
View File

@ -2,73 +2,9 @@
local S = awards.gettext local S = awards.gettext
local function order_awards(name)
local hash_is_unlocked = {}
local retval = {}
local data = awards.player(name)
if data and data.unlocked then
for awardname, _ in pairs(data.unlocked) do
local def = awards.registered_awards[awardname]
if def then
hash_is_unlocked[awardname] = true
local score = -100000
local difficulty = def.difficulty or 1
if def.trigger and def.trigger.target then
difficulty = difficulty * def.trigger.target
end
score = score + difficulty
retval[#retval + 1] = {
name = awardname,
def = def,
unlocked = true,
started = true,
score = score,
}
end
end
end
for _, def in pairs(awards.registered_awards) do
if not hash_is_unlocked[def.name] and def:can_unlock(data) then
local started = false
local score = def.difficulty or 1
if def.secret then
score = 1000000
elseif def.trigger and def.trigger.target and def.getProgress then
local progress = def:getProgress(data).perc
score = score * (1 - progress) * def.trigger.target
if progress < 0.001 then
score = score + 100
else
started = true
end
else
score = 100
end
retval[#retval + 1] = {
name = def.name,
def = def,
unlocked = false,
started = started,
score = score,
}
end
end
table.sort(retval, function(a, b)
return a.score < b.score
end)
return retval
end
function awards.get_formspec(name, to, sid) function awards.get_formspec(name, to, sid)
local formspec = "" local formspec = ""
local awards_list = order_awards(name) local awards_list = awards.get_award_states(name)
local data = awards.player(name)
if #awards_list == 0 then if #awards_list == 0 then
formspec = formspec .. "label[3.9,1.5;"..minetest.formspec_escape(S("Error: No achivements available.")).."]" formspec = formspec .. "label[3.9,1.5;"..minetest.formspec_escape(S("Error: No achivements available.")).."]"
@ -106,15 +42,11 @@ function awards.get_formspec(name, to, sid)
if sdef and sdef.icon then if sdef and sdef.icon then
formspec = formspec .. "image[0.45,0;3.5,3.5;" .. sdef.icon .. "]" -- adjusted values from 0.6,0;3,3 formspec = formspec .. "image[0.45,0;3.5,3.5;" .. sdef.icon .. "]" -- adjusted values from 0.6,0;3,3
end end
local barwidth = 3.95
local perc = nil if sitem.progress then
local label = nil local barwidth = 3.95
if sdef.getProgress and data then local perc = sitem.progress.current / sitem.progress.target
local res = sdef:getProgress(data) local label = sitem.progress.label
perc = res.perc
label = res.label
end
if perc then
if perc > 1 then if perc > 1 then
perc = 1 perc = 1
end end
@ -124,6 +56,7 @@ function awards.get_formspec(name, to, sid)
formspec = formspec .. "label[1.6,8.15;" .. minetest.formspec_escape(label) .. "]" formspec = formspec .. "label[1.6,8.15;" .. minetest.formspec_escape(label) .. "]"
end end
end end
if sdef and sdef.description then if sdef and sdef.description then
formspec = formspec .. "box[-0.05,3.75;3.9,4.2;#000]" formspec = formspec .. "box[-0.05,3.75;3.9,4.2;#000]"
formspec = formspec .. "textarea[0.25,3.75;3.9,4.2;;" .. formspec = formspec .. "textarea[0.25,3.75;3.9,4.2;;" ..
@ -174,7 +107,7 @@ function awards.show_to(name, to, sid, text)
return return
end end
if text then if text then
local awards_list = order_awards(name) local awards_list = awards.get_award_states(name)
if #awards_list == 0 then if #awards_list == 0 then
minetest.chat_send_player(to, S("Error: No award available.")) minetest.chat_send_player(to, S("Error: No award available."))
return return