Fix bug with getting player data, and release 2.1.1

LICENSE.txt

@@ -0,0 +1,502 @@
+                  GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL.  It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+  This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it.  You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+  When we speak of free software, we are referring to freedom of use,
+not price.  Our General Public Licenses are designed to make sure that
+you have the freedom to distribute copies of free software (and charge
+for this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+  To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights.  These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+  For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you.  You must make sure that they, too, receive or can get the source
+code.  If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it.  And you must show them these terms so they know their rights.
+
+  We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+  To protect each distributor, we want to make it very clear that
+there is no warranty for the free library.  Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+  Finally, software patents pose a constant threat to the existence of
+any free program.  We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder.  Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+  Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License.  This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License.  We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+  When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library.  The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom.  The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+  We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License.  It also provides other free software developers Less
+of an advantage over competing non-free programs.  These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries.  However, the Lesser license provides advantages in certain
+special circumstances.
+
+  For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard.  To achieve this, non-free programs must be
+allowed to use the library.  A more frequent case is that a free
+library does the same job as widely used non-free libraries.  In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+  In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software.  For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+  Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.  Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library".  The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+                  GNU LESSER GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+  A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+  The "Library", below, refers to any such software library or work
+which has been distributed under these terms.  A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language.  (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+  "Source code" for a work means the preferred form of the work for
+making modifications to it.  For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+  Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it).  Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+  1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+  You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+  2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) The modified work must itself be a software library.
+
+    b) You must cause the files modified to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    c) You must cause the whole of the work to be licensed at no
+    charge to all third parties under the terms of this License.
+
+    d) If a facility in the modified Library refers to a function or a
+    table of data to be supplied by an application program that uses
+    the facility, other than as an argument passed when the facility
+    is invoked, then you must make a good faith effort to ensure that,
+    in the event an application does not supply such function or
+    table, the facility still operates, and performs whatever part of
+    its purpose remains meaningful.
+
+    (For example, a function in a library to compute square roots has
+    a purpose that is entirely well-defined independent of the
+    application.  Therefore, Subsection 2d requires that any
+    application-supplied function or table used by this function must
+    be optional: if the application does not supply it, the square
+    root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library.  To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License.  (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.)  Do not make any other change in
+these notices.
+
+  Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+  This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+  4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+  If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library".  Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+  However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library".  The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+  When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library.  The
+threshold for this to be true is not precisely defined by law.
+
+  If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work.  (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+  Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+  6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+  You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License.  You must supply a copy of this License.  If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License.  Also, you must do one
+of these things:
+
+    a) Accompany the work with the complete corresponding
+    machine-readable source code for the Library including whatever
+    changes were used in the work (which must be distributed under
+    Sections 1 and 2 above); and, if the work is an executable linked
+    with the Library, with the complete machine-readable "work that
+    uses the Library", as object code and/or source code, so that the
+    user can modify the Library and then relink to produce a modified
+    executable containing the modified Library.  (It is understood
+    that the user who changes the contents of definitions files in the
+    Library will not necessarily be able to recompile the application
+    to use the modified definitions.)
+
+    b) Use a suitable shared library mechanism for linking with the
+    Library.  A suitable mechanism is one that (1) uses at run time a
+    copy of the library already present on the user's computer system,
+    rather than copying library functions into the executable, and (2)
+    will operate properly with a modified version of the library, if
+    the user installs one, as long as the modified version is
+    interface-compatible with the version that the work was made with.
+
+    c) Accompany the work with a written offer, valid for at
+    least three years, to give the same user the materials
+    specified in Subsection 6a, above, for a charge no more
+    than the cost of performing this distribution.
+
+    d) If distribution of the work is made by offering access to copy
+    from a designated place, offer equivalent access to copy the above
+    specified materials from the same place.
+
+    e) Verify that the user has already received a copy of these
+    materials or that you have already sent this user a copy.
+
+  For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it.  However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+  It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system.  Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+  7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+    a) Accompany the combined library with a copy of the same work
+    based on the Library, uncombined with any other library
+    facilities.  This must be distributed under the terms of the
+    Sections above.
+
+    b) Give prominent notice with the combined library of the fact
+    that part of it is a work based on the Library, and explaining
+    where to find the accompanying uncombined form of the same work.
+
+  8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License.  Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License.  However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+  9. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Library or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+  10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+  11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded.  In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+  13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation.  If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+  14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission.  For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this.  Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+                            NO WARRANTY
+
+  15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+           How to Apply These Terms to Your New Libraries
+
+  If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change.  You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+  To apply these terms, attach the following notices to the library.  It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the library's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the
+  library `Frob' (a library for tweaking knobs) written by James Random Hacker.
+
+  <signature of Ty Coon>, 1 April 1990
+  Ty Coon, President of Vice
+
+That's all there is to it!

api.lua

@@ -1,13 +1,24 @@
 -- AWARDS
---    by Rubenwardy
--------------------------------------------------------
--- this is api function file
--------------------------------------------------------
+--
+-- Copyright (C) 2013-2015 rubenwardy
+-- This program is free software; you can redistribute it and/or modify
+-- it under the terms of the GNU Lesser General Public License as published by
+-- the Free Software Foundation; either version 2.1 of the License, or
+-- (at your option) any later version.
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Lesser General Public License for more details.
+-- You should have received a copy of the GNU Lesser General Public License along
+-- with this program; if not, write to the Free Software Foundation, Inc.,
+-- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+--
 
 -- The global award namespace
 awards = {
 	show_mode = "hud"
 }
+dofile(minetest.get_modpath("awards").."/api_helpers.lua")
 
 -- Table Save Load Functions
 function awards.save()
@@ -18,6 +29,19 @@ function awards.save()
 	end
 end
 
+local S = function(s) return s end
+function awards.set_intllib(locale)
+	S = locale
+end
+
+function awards.init()
+	awards.players = awards.load()
+	awards.def = {}
+	awards.trigger_types = {}
+	awards.on = {}
+	awards.on_unlock = {}
+end
+
 function awards.load()
 	local file = io.open(minetest.get_worldpath().."/awards.txt", "r")
 	if file then
@@ -29,234 +53,161 @@ function awards.load()
 	return {}
 end
 
-awards.players = awards.load()
-function awards.player(name)
-	return awards.players[name]
-end
-
--- A table of award definitions
-awards.def = {}
-
-function awards.tbv(tb,value,default)
-	if not default then
-		default = {}
-	end
-	if not tb or type(tb) ~= "table" then
-		if not value then
-			value = "[NULL]"
-		end
-		minetest.log("error", "awards.tbv - table "..dump(value).." is null, or not a table! Dump: "..dump(tb))
-		return
-	end
-	if not value then
-		error("[ERROR] awards.tbv was not used correctly!\n"..
-			"Value: '"..dump(value).."'\n"..
-			"Dump:"..dump(tb))
-		return
-	end
-	if not tb[value] then
-		tb[value] = default
+function awards.register_trigger(name, func)
+	awards.trigger_types[name] = func
+	awards.on[name] = {}
+	awards['register_on_'..name] = function(func)
+		table.insert(awards.on[name], func)
 	end
 end
 
-function awards.assertPlayer(playern)
-	awards.tbv(awards.players, playern)
-	awards.tbv(awards.players[playern], "name", playern)
-	awards.tbv(awards.players[playern], "unlocked")
-	awards.tbv(awards.players[playern], "place")
-	awards.tbv(awards.players[playern], "count")
-	awards.tbv(awards.players[playern], "craft")
-	awards.tbv(awards.players[playern], "deaths", 0)
-	awards.tbv(awards.players[playern], "joins", 0)
-	awards.tbv(awards.players[playern], "chats", 0)
+function awards.run_trigger_callbacks(player, data, trigger, table_func)
+	for i = 1, #awards.on[trigger] do
+		local res = nil
+		local entry = awards.on[trigger][i]
+		if type(entry) == "function" then
+			res = entry(player, data)
+		elseif type(entry) == "table" and entry.award then
+			res = table_func(entry)
 		end
 
--- Load files
-dofile(minetest.get_modpath("awards").."/triggers.lua")
+		if res then
+			awards.unlock(player:get_player_name(), res)
+		end
+	end
+end
+
+function awards.increment_item_counter(data, field, itemname)
+	local name_split = string.split(itemname, ":")
+	if #name_split ~= 2 then
+		return false
+	end
+	local mod = name_split[1]
+	local item = name_split[2]
+
+	if data and field and mod and item then
+		awards.assertPlayer(data)
+		awards.tbv(data, field)
+		awards.tbv(data[field], mod)
+		awards.tbv(data[field][mod], item, 0)
+
+		data[field][mod][item] = data[field][mod][item] + 1
+		return true
+	else
+		return false
+	end
+end
+
+function awards.register_on_unlock(func)
+	table.insert(awards.on_unlock, func)
+end
 
 -- API Functions
-function awards._additional_triggers(name, data_table)
-	-- To add triggers in another mod, you should override this function
-	-- If the code can't handle the trigger passed, then call the last value of _additional_triggers
-	--[[
-		local add_trig = awards._additional_triggers
-		awards._additional_triggers = function(name, data_table)
-			if data_table.trigger.type == "trigger" then
-				local tmp = {
-					award = name,
-					node = data_table.trigger.node,
-					target = data_table.trigger.target,
-				}
-				table.insert(awards.onTrigger,tmp)
-			elseif data_table.trigger.type == "trigger2" then
-				local tmp = {
-					award = name,
-					node = data_table.trigger.node,
-					target = data_table.trigger.target,
-				}
-				table.insert(awards.onTrigger2,tmp)
+function awards._additional_triggers(name, def)
+	-- Depreciated!
+end
+
+function awards.register_achievement(name, def)
+	def.name = name
+
+	-- Add Triggers
+	if def.trigger and def.trigger.type then
+		local func = awards.trigger_types[def.trigger.type]
+
+		if func then
+			func(def)
 		else
-				add_trig(name, data_table)
-			end
-		end
-	]]--
-end
-function awards.register_achievement(name,data_table)
-	-- see if a trigger is defined in the achievement definition
-	if data_table.trigger and data_table.trigger.type then
-		if data_table.trigger.type == "dig" then
-			local tmp = {
-				award = name,
-			 	node = data_table.trigger.node,
-			 	target = data_table.trigger.target,
-			}
-			table.insert(awards.onDig,tmp)
-		elseif data_table.trigger.type == "place" then
-			local tmp = {
-				award = name,
-			 	node = data_table.trigger.node,
-			 	target = data_table.trigger.target,
-			}
-			table.insert(awards.onPlace,tmp)
-		elseif data_table.trigger.type == "craft" then
-			local tmp = {
-				award = name,
-			 	item = data_table.trigger.item,
-			 	target = data_table.trigger.target,
-			}
-			table.insert(awards.onCraft,tmp)
-		elseif data_table.trigger.type == "death" then
-			local tmp = {
-				award = name,
-			 	target = data_table.trigger.target,
-			}
-			table.insert(awards.onDeath,tmp)
-		elseif data_table.trigger.type == "chat" then
-			local tmp = {
-				award = name,
-			 	target = data_table.trigger.target,
-			}
-			table.insert(awards.onChat,tmp)
-		elseif data_table.trigger.type == "join" then
-			local tmp = {
-				award = name,
-			 	target = data_table.trigger.target,
-			}
-			table.insert(awards.onJoin,tmp)
-		else
-			awards._additional_triggers(name, data_table)
+			awards._additional_triggers(name, def)
 		end
 	end
 
-	-- check icon, background and custom_announce data
-	if data_table.icon == nil or data_table.icon == "" then
-		data_table.icon = "unknown.png"
-	end
-	if data_table.background == nil or data_table.background == "" then
-		data_table.background = "bg_default.png"
-	end
-	if data_table.custom_announce == nil or data_table.custom_announce == "" then
-		data_table.custom_announce = "Achievement Unlocked:"
+	-- Add Award
+	awards.def[name] = def
 end
 
-	-- add the achievement to the definition table
-	data_table.name = name
-	awards.def[name] = data_table
+function awards.enable(name)
+	local data = awards.player(name)
+	if data then
+		data.disabled = nil
+	end
 end
 
--- run a function when a node is dug
-function awards.register_onDig(func)
-	table.insert(awards.onDig,func)
+function awards.disable(name)
+	local data = awards.player(name)
+	if data then
+		data.disabled = true
+	end
 end
 
--- run a function when a node is placed
-function awards.register_onPlace(func)
-	table.insert(awards.onPlace,func)
-end
-
--- run a function when a player dies
-function awards.register_onDeath(func)
-	table.insert(awards.onDeath,func)
-end
-
--- run a function when a player chats
-function awards.register_onChat(func)
-	table.insert(awards.onChat,func)
-end
-
--- run a function when a player joins
-function awards.register_onJoin(func)
-	table.insert(awards.onJoin,func)
-end
-
--- run a function when an item is crafted
-function awards.register_onCraft(func)
-	table.insert(awards.onCraft,func)
+function awards.clear_player(name)
+	awards.players[name] = nil
 end
 
 -- This function is called whenever a target condition is met.
 -- It checks if a player already has that achievement, and if they do not,
 -- it gives it to them
 ----------------------------------------------
---awards.give_achievement(name,award)
+--awards.unlock(name, award)
 -- name - the name of the player
 -- award - the name of the award to give
-function awards.give_achievement(name, award)
+function awards.unlock(name, award)
 	-- Access Player Data
 	local data  = awards.players[name]
+	local awdef = awards.def[award]
 
 	-- Perform checks
 	if not data then
 		return
 	end
-	if not awards.def[award] then
+	if not awdef then
+		return
+	end
+	if data.disabled then
 		return
 	end
 	awards.tbv(data,"unlocked")
 
-	-- check to see if the player does not already have that achievement
-	if not data.unlocked[award] or data.unlocked[award]~=award then
-		-- Set award flag
+	-- Don't give the achievement if it has already been given
+	if data.unlocked[award] and data.unlocked[award] == award then
+		return
+	end
+
+	-- Unlock Award
+	minetest.log("action", name.." has unlocked award "..name)
 	data.unlocked[award] = award
+	awards.save()
 
 	-- Give Prizes
-		if awards.def[award] and awards.def[award].prizes then
-			for i = 1, #awards.def[award].prizes do
-				local itemstack = ItemStack(awards.def[award].prizes[i])
-				if itemstack:is_empty() or not itemstack:is_known() then
-					return
-				end
-				local receiverref = core.get_player_by_name(name)
-				if receiverref == nil then
-					return
-				end
+	if awdef and awdef.prizes then
+		for i = 1, #awdef.prizes do
+			local itemstack = ItemStack(awdef.prizes[i])
+			if not itemstack:is_empty() then
+				local receiverref = minetest.get_player_by_name(name)
+				if receiverref then
 					receiverref:get_inventory():add_item("main", itemstack)
 				end
 			end
-
-		-- Get data from definition tables
-		local title = award
-		local desc = ""
-		local background = ""
-		local icon = ""
-		local custom_announce = ""
-		if awards.def[award].title then
-			title = awards.def[award].title
 		end
-		if awards.def[award].custom_announce then
-			custom_announce = awards.def[award].custom_announce
-		end
-		if awards.def[award].background then
-			background = awards.def[award].background
-		end
-		if awards.def[award].icon then
-			icon = awards.def[award].icon
-		end
-		if awards.def[award] and awards.def[award].description then
-			desc = awards.def[award].description
 	end
 
-		-- send the won award message to the player
+	-- Run callbacks
+	if awdef.on_unlock and awdef.on_unlock(name, awdef) then
+		return
+	end
+	for _, callback in pairs(awards.on_unlock) do
+		if callback(name, awdef) then
+			return
+		end
+	end
+
+	-- Get Notification Settings
+	local title = awdef.title or award
+	local desc = awdef.description or ""
+	local background = awdef.background or "bg_default.png"
+	local icon = awdef.icon or "unknown.png"
+	local custom_announce = awdef.custom_announce or S("Achievement Unlocked:")
+
+	-- Do Notification
 	if awards.show_mode == "formspec" then
 		-- use a formspec to send it
 		minetest.show_formspec(name, "achievements:unlocked", "size[4,2]"..
@@ -266,7 +217,7 @@ function awards.give_achievement(name, award)
 				"label[0.3,0.1;"..custom_announce.."]")
 	elseif awards.show_mode == "chat" then
 		-- use the chat console to send it
-			minetest.chat_send_player(name, "Achievement Unlocked: "..title)
+		minetest.chat_send_player(name, S("Achievement Unlocked:")..title)
 		if desc~="" then
 			minetest.chat_send_player(name, desc)
 		end
@@ -317,107 +268,20 @@ function awards.give_achievement(name, award)
 			player:hud_remove(four)
 		end)
 	end
-	
-		-- record this in the log	
-		minetest.log("action", name.." has unlocked award "..title)
-		
-		-- save playertable
-		awards.save()
-	end
 end
 
--- List a player's achievements
-minetest.register_chatcommand("list_awards", {
-	params = "obsolete",
-	description = "list_awards: obsolete. Use /awards",
-	func = function(name, param)
-		minetest.chat_send_player(name, "This command has been made obsolete. Use /awards instead.")
-		awards.showto(name, name, nil, false)
-	end
-})
-minetest.register_chatcommand("awards", {
-	params = "",
-	description = "awards: list awards",
-	func = function(name, param)
-		awards.showto(name, name, nil, false)
-	end
-})
-minetest.register_chatcommand("cawards", {
-	params = "",
-	description = "awards: list awards in chat",
-	func = function(name, param)
-		awards.showto(name, name, nil, true)
-	end
-})
-minetest.register_chatcommand("awd", {
-	params = "award name",
-	description = "awd: Details of awd gotten",
-	func = function(name, param)
-		local def = awards.def[param]
-		if def then
-			minetest.chat_send_player(name,def.title..": "..def.description)
-		else
-			minetest.chat_send_player(name,"Award not found.")
-		end
-	end
-})
+-- Backwards compatibility
+awards.give_achievement = awards.unlock
+
 --[[minetest.register_chatcommand("gawd", {
 	params = "award name",
 	description = "gawd: give award to self",
 	func = function(name, param)
-		awards.give_achievement(name,param)
+		awards.unlock(name,param)
 	end
 })]]--
 
-function awards._order_awards(name)
-	local done = {}
-	local retval = {}
-	local player = awards.player(name)
-	if player and player.unlocked then
-		for _,got in pairs(player.unlocked) do
-			if awards.def[got] then
-				done[got] = true
-				table.insert(retval,{name=got,got=true})
-			end
-		end
-	end
-	for _,def in pairs(awards.def) do
-		if not done[def.name] then
-			table.insert(retval,{name=def.name,got=false})
-		end
-	end
-	return retval
-end
-
-function awards.showto(name, to, sid, text)
-	if name == "" or name == nil then
-		name = to
-	end
-	if text then
-		if not awards.players[name] or not awards.players[name].unlocked  then
-			minetest.chat_send_player(to, "You have not unlocked any awards")
-			return
-		end
-		minetest.chat_send_player(to, name.."'s awards:")
-
-		for _, str in pairs(awards.players[name].unlocked) do
-			local def = awards.def[str]
-			if def then
-				if def.title then
-					if def.description then				
-						minetest.chat_send_player(to, def.title..": "..def.description)
-					else
-						minetest.chat_send_player(to, def.title)
-					end
-				else
-					minetest.chat_send_player(to, str)
-				end
-			end
-		end
-	else
-		if sid == nil or sid < 1 then
-			sid = 1
-		end
+function awards.getFormspec(name, to, sid)
 	local formspec = "size[11,5]"
 	local listofawards = awards._order_awards(name)
 
@@ -440,12 +304,10 @@ function awards.showto(name, to, sid, text)
 			if item.got then
 				status = " (got)"
 			end
-				local icon = ""
+			formspec = formspec .. "label[1,2.75;" .. title .. status .. "]"
 			if def and def.icon then
-					icon = def.icon
+				formspec = formspec .. "image[1,0;3,3;" .. def.icon .. "]"
 			end
-				formspec = formspec .. "label[1,2.75;"..title..status.."]"..
-									"image[1,0;3,3;"..icon.."]"
 			if def and def.description then
 				formspec = formspec	.. "label[0,3.25;"..def.description.."]"
 			end
@@ -478,12 +340,48 @@ function awards.showto(name, to, sid, text)
 			end
 		end
 	end
-		formspec = formspec .. ";"..sid.."]"
+	return formspec .. ";"..sid.."]"
+end
 
+function awards.show_to(name, to, sid, text)
+	if name == "" or name == nil then
+		name = to
+	end
+	if name == to and awards.player(to).disabled then
+		minetest.chat_send_player("You've disabled awards. Type /awards" ..
+				" enable to reenable")
+		return
+	end
+	if text then
+		if not awards.players[name] or not awards.players[name].unlocked  then
+			minetest.chat_send_player(to, "You have not unlocked any awards")
+			return
+		end
+		minetest.chat_send_player(to, name.."'s awards:")
+
+		for _, str in pairs(awards.players[name].unlocked) do
+			local def = awards.def[str]
+			if def then
+				if def.title then
+					if def.description then
+						minetest.chat_send_player(to, def.title..": "..def.description)
+					else
+						minetest.chat_send_player(to, def.title)
+					end
+				else
+					minetest.chat_send_player(to, str)
+				end
+			end
+		end
+	else
+		if sid == nil or sid < 1 then
+			sid = 1
+		end
 		-- Show formspec to user
-		minetest.show_formspec(to,"awards:awards",formspec)
+		minetest.show_formspec(to,"awards:awards", awards.getFormspec(name, to, sid))
 	end
 end
+awards.showto = awards.show_to
 
 minetest.register_on_player_receive_fields(function(player, formname, fields)
 	if formname ~= "awards:awards" then
@@ -496,10 +394,20 @@ minetest.register_on_player_receive_fields(function(player, formname, fields)
 	if fields.awards then
 		local event = minetest.explode_textlist_event(fields.awards)
 		if event.type == "CHG" then
-			awards.showto(name,name,event.index,false)	
+			awards.show_to(name, name, event.index, false)
 		end
 	end
 
 	return true
 end)
 
+awards.init()
+
+minetest.register_on_newplayer(function(player)
+	local playern = player:get_player_name()
+	awards.assertPlayer(playern)
+end)
+
+minetest.register_on_shutdown(function()
+	awards.save()
+end)

api_helpers.lua

@@ -0,0 +1,57 @@
+function awards.tbv(tb,value,default)
+	if not default then
+		default = {}
+	end
+	if not tb or type(tb) ~= "table" then
+		if not value then
+			value = "[NULL]"
+		end
+		minetest.log("error", "awards.tbv - table "..dump(value).." is null, or not a table! Dump: "..dump(tb))
+		return
+	end
+	if not value then
+		error("[ERROR] awards.tbv was not used correctly!\n"..
+			"Value: '"..dump(value).."'\n"..
+			"Dump:"..dump(tb))
+		return
+	end
+	if not tb[value] then
+		tb[value] = default
+	end
+end
+
+function awards.assertPlayer(playern)
+	awards.tbv(awards.players, playern)
+	awards.tbv(awards.players[playern], "name", playern)
+	awards.tbv(awards.players[playern], "unlocked")
+	awards.tbv(awards.players[playern], "place")
+	awards.tbv(awards.players[playern], "count")
+	awards.tbv(awards.players[playern], "craft")
+	awards.tbv(awards.players[playern], "deaths", 0)
+	awards.tbv(awards.players[playern], "joins", 0)
+	awards.tbv(awards.players[playern], "chats", 0)
+end
+
+function awards.player(name)
+	return awards.players[name]
+end
+
+function awards._order_awards(name)
+	local done = {}
+	local retval = {}
+	local player = awards.player(name)
+	if player and player.unlocked then
+		for _,got in pairs(player.unlocked) do
+			if awards.def[got] then
+				done[got] = true
+				table.insert(retval,{name=got,got=true})
+			end
+		end
+	end
+	for _,def in pairs(awards.def) do
+		if not done[def.name] then
+			table.insert(retval,{name=def.name,got=false})
+		end
+	end
+	return retval
+end

chat_commands.lua

@@ -0,0 +1,75 @@
+-- AWARDS
+--
+-- Copyright (C) 2013-2015 rubenwardy
+-- This program is free software; you can redistribute it and/or modify
+-- it under the terms of the GNU Lesser General Public License as published by
+-- the Free Software Foundation; either version 2.1 of the License, or
+-- (at your option) any later version.
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Lesser General Public License for more details.
+-- You should have received a copy of the GNU Lesser General Public License along
+-- with this program; if not, write to the Free Software Foundation, Inc.,
+-- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+--
+
+minetest.register_chatcommand("awards", {
+	params = "",
+	description = "awards: list awards",
+	func = function(name, param)
+		if param == "clear" then
+			awards.clear_player(name)
+			minetest.chat_send_player(name, "All your awards and statistics " ..
+					" have been cleared. You can now start again.")
+		elseif param == "disable" then
+			awards.disable(name)
+			minetest.chat_send_player(name, "You have disabled awards. (only affects you)")
+		elseif param == "enable" then
+			awards.enable(name)
+			minetest.chat_send_player(name, "You have enabled awards. (only affects you)")
+		elseif param == "c" then
+			awards.show_to(name, name, nil, true)
+		else
+			awards.show_to(name, name, nil, false)
+		end
+	end
+})
+
+minetest.register_chatcommand("cawards", {
+	params = "",
+	description = "awards: list awards in chat",
+	func = function(name, param)
+		awards.show_to(name, name, nil, true)
+		minetest.chat_send_player(name, "/cawards has been depreciated," ..
+				" use /awards c instead")
+	end
+})
+
+minetest.register_chatcommand("awd", {
+	params = "award name",
+	description = "awd: Details of awd gotten",
+	func = function(name, param)
+		local def = awards.def[param]
+		if def then
+			minetest.chat_send_player(name,def.title..": "..def.description)
+		else
+			minetest.chat_send_player(name,"Award not found.")
+		end
+	end
+})
+
+minetest.register_chatcommand("awpl", {
+	privs = {
+		server = true
+	},
+	description = "awpl: Get the statistics for the player given",
+	func = function(name, param)
+		if not param or param == "" then
+			param = name
+		end
+		minetest.chat_send_player(name, param)
+		local player = awards.player(param)
+		minetest.chat_send_player(name, dump(player))
+	end
+})

init.lua

@@ -1,8 +1,19 @@
 -- AWARDS
---    by Rubenwardy
--------------------------------------------------------
--- this is the init file for the award mod
--------------------------------------------------------
+--
+-- Copyright (C) 2013-2015 rubenwardy
+-- This program is free software; you can redistribute it and/or modify
+-- it under the terms of the GNU Lesser General Public License as published by
+-- the Free Software Foundation; either version 2.1 of the License, or
+-- (at your option) any later version.
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Lesser General Public License for more details.
+-- You should have received a copy of the GNU Lesser General Public License along
+-- with this program; if not, write to the Free Software Foundation, Inc.,
+-- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+--
+
 
 local S
 if (intllib) then
@@ -13,6 +24,9 @@ else
 end
 
 dofile(minetest.get_modpath("awards").."/api.lua")
+dofile(minetest.get_modpath("awards").."/chat_commands.lua")
+dofile(minetest.get_modpath("awards").."/triggers.lua")
+awards.set_intllib(S)
 
 -- Light it up
 awards.register_achievement("award_lightitup",{
@@ -27,8 +41,8 @@ awards.register_achievement("award_lightitup",{
 })
 
 -- Light ALL the things!
-awards.register_achievement("award_light_all_the_things",{
-	title = S("Light ALL The Things!"),
+awards.register_achievement("award_well_lit",{
+	title = S("Well Lit"),
 	description = S("Place 1,000 torches."),
 	icon = "novicebuilder.png",
 	trigger = {
@@ -200,25 +214,11 @@ awards.register_achievement("award_youre_a_copper",{
 	}
 })
 
--- You're winner
-awards.register_achievement("award_youre_winner",{
-	title = S("YOU'RE A WINNER!"),
-	description = S("Dig 1 mossy cobblestone."),
-	icon = "miniminer.png",
-	background = "bg_mining.png",
-	trigger = {
-		type = "dig",
-		node = "default:mossycobble",
-		target = 1
-	},
-	secret = true,
-})
-
 -- Found a Nyan cat!
 awards.register_achievement("award_nyanfind", {
 	title = S("OMG, Nyan Cat!"),
 	description = S("Find a nyan cat."),
-	icon = "default_nc_rb.png",
+	icon = "nyancat_front.png",
 	trigger = {
 		type = "dig",
 		node = "default:nyancat",
@@ -277,6 +277,16 @@ awards.register_achievement("award_marchand_de_sable",{
 	}
 })
 
+awards.register_achievement("awards_crafter_of_sticks", {
+	title = S("Crafter of Sticks"),
+	description = S("Create 100 Sticks"),
+	trigger = {
+		type = "craft",
+		item = "default:stick",
+		target = 100
+	}
+})
+
 -- Join
 awards.register_achievement("award_join2", {
 	title = S("Frequent Visitor"),
@@ -350,7 +360,7 @@ awards.register_achievement("award_this_is_sad",{
 	title = S("This is Sad"),
 	description = S("Die near diamond ore.")
 })
-awards.register_onDeath(function(player,data)
+awards.register_on_death(function(player,data)
 	local pos = player:getpos()
 	if pos and minetest.find_node_near(pos, 5, "default:stone_with_diamond") ~= nil then
 		return "award_this_is_sad"
@@ -363,7 +373,7 @@ awards.register_achievement("award_the_stack",{
 	title = S("The Stack"),
 	description = S("Die near bones.")
 })
-awards.register_onDeath(function(player,data)
+awards.register_on_death(function(player,data)
 	local pos = player:getpos()
 	if pos and minetest.find_node_near(pos, 5, "bones:bones") ~= nil then
 		return "award_the_stack"
@@ -371,3 +381,30 @@ awards.register_onDeath(function(player,data)
 	return nil
 end)
 
+-- Die near diamond ore
+awards.register_achievement("award_deep_down", {
+	title = S("Deep Down"),
+	description = S("Die below -10000"),
+	secret = true
+})
+awards.register_on_death(function(player,data)
+	local pos = player:getpos()
+	if pos and pos.y < -10000 then
+		return "award_deep_down"
+	end
+	return nil
+end)
+
+-- Die near diamond ore
+awards.register_achievement("award_no_screen", {
+	title = S("In space, no one can hear you scream"),
+	description = S("Die above 10000"),
+	secret = true
+})
+awards.register_on_death(function(player,data)
+	local pos = player:getpos()
+	if pos and pos.y > 10000 then
+		return "award_no_screen"
+	end
+	return nil
+end)

locale/template.txt

@@ -0,0 +1,61 @@
+Achievement Unlocked: =
+Light It Up =
+Place 100 torches. =
+Light ALL The Things! =
+Place 1,000 torches. =
+Saint-Maclou =
+Place 20 coal checkers. =
+Castorama =
+Place 20 iron checkers. =
+Sam the Trapper =
+Place 2 trap stones. =
+Obsessed with Obsidian =
+Mine 50 obsidian. =
+On The Way =
+Place 100 rails. =
+Lumberjack =
+Dig 100 tree blocks. =
+Semi-pro Lumberjack =
+Dig 1,000 tree blocks. =
+Professional Lumberjack =
+Dig 10,000 tree blocks. =
+L33T Lumberjack =
+Dig 100,000 tree blocks. =
+Junglebaby =
+Dig 100 jungle tree blocks. =
+Jungleman =
+Dig 1,000 jungle tree blocks. =
+First Mese Find =
+Find some Mese. =
+You're a copper =
+Dig 1,000 copper ores. =
+OMG, Nyan Cat! =
+Find a nyan cat. =
+Mini Miner =
+Dig 100 stone blocks. =
+Hardened Miner =
+Dig 1,000 stone blocks =
+Master Miner =
+Dig 10,000 stone blocks. =
+Marchand De Sable =
+Dig 1,000 sand. =
+Frequent Visitor =
+Connect to the server 50 times. =
+Dying Spree =
+Die 5 times. =
+Bot-like =
+Die 10 times. =
+You Suck! =
+Die 100 times. =
+You're a witch! =
+Burn to death in a fire. =
+In the Flow =
+Die in flowing lava. =
+This is Sad =
+Die near diamond ore. =
+The Stack =
+Die near bones. =
+Deep Down =
+Die below -10000 =
+In space, no one can hear you scream =
+Die above 10000 =

mod.conf

@@ -4,4 +4,4 @@ author = rubenwardy
 description = Adds achievements to Minetest, and an API to register new ones.
 license = LGPL 2.1 or later
 forum = https://forum.minetest.net/viewtopic.php?t=4870
-version = 0.5
+version = 2.1.1

readme.md

@@ -1,5 +1,4 @@
-Awards
-------
+# Awards
 
 by Andrew "Rubenwardy" Ward, LGPL 2.1 or later.
 
@@ -9,40 +8,118 @@ Majority of awards are back ported from Calinou's
 old fork in Carbone, under same license.
 
 
-Code Reference
---------------
+# Basic API
 
-The API
-=======
-* awards.register_achievement(name,data_table)
+* awards.register_achievement(name, def)
 	* name
 	* desciption
 	* sound [optional]
-	* image [optional]
+	* image [optional] - texture name, eg: award_one.png
+	* background [optional] - texture name, eg: award_one.png
 	* trigger [optional] [table]
 		* type - "dig", "place", "craft", "death", "chat" or "join"
 		* (for dig/place type) node - the nodes name
 		* (for craft type) item - the items name
 		* (for all types) target - how many to dig / place
+		* See Triggers
 	* secret [optional] - if true, then player needs to unlock to find out what it is.
-* awards.give_achievement(name,award)
-	* -- gives an award to a player
-* awards.register_onDig(func(player,data))
-	* -- return award name or null
-* awards.register_onPlace(func(player,data))
-	* -- return award name or null
-* awards.register_onDeath(func(player,data))
-	* -- return award name or null
-* awards.register_onChat(func(player,data))
-	* -- return award name or null
-* awards.register_onJoin(func(player,data))
-	* -- return award name or null
-* awards.register_onCraft(func(player,data))
-	* -- return award name or null
+	* on_unlock [optional] - func(name, def)
+		* name is player name
+		* return true to cancel register_on_unlock callbacks and HUD
+* awards.register_trigger(name, func(awardname, def))
+	* Note: awards.on[name] is automatically created for triggers
+* awards.run_trigger_callbacks(player, data, trigger, table_func(entry))
+	* Goes through and checks all triggers registered to a trigger type,
+	  unlocking the award if conditions are met.
+	* data is the player's award data, ie: awards.players[player_name]
+	* trigger is the name of the trigger type. Ie: awards.on[trigger]
+	* table_func is called if the trigger is a table - simply return an
+	  award name to unlock it
+	* See triggers.lua for examples
+* awards.increment_item_counter(data, field, itemname)
+	* add to an item's statistic count
+	* for example, (data, "place", "default:stone") will add 1 to the number of
+	  times default:stone has been placed.
+	* data is the player's award data, ie: awards.players[player_name]
+	* returns true on success, false on failure (eg: cannot get modname and item from itemname)
+* awards.register_on_unlock(func(name, def))
+	* 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
+
+# Included in the Mod
+
+The API, above, allows you to register awards
+and triggers (things that look for events and unlock awards, they need
+to be registered in order to get details from award_def.trigger).
+
+However, all awards and triggers are separate from the API.
+They can be found in init.lua and triggers.lua
+
+## Triggers
+
+Callbacks (register a function to be run)
+
+### dig
+
+	trigger = {
+		type = "dig",
+		node = "default:dirt",
+		target = 50
+	}
+
+### place
+
+	trigger = {
+		type = "place",
+		node = "default:dirt",
+		target = 50
+	}
+
+### death
+
+	trigger = {
+		type = "death",
+		target = 5
+	}
+
+### chat
+
+	trigger = {
+		type = "chat",
+		target = 100
+	}
+
+### join
+
+	trigger = {
+		type = "join",
+		target = 100
+	}
+
+## Callbacks relating to triggers
+
+* awards.register_on_dig(func(player, data))
+	* data is player data (see below)
+	* return award name or null
+* awards.register_on_place(func(player, data))
+	* data is player data (see below)
+	* return award name or null
+* awards.register_on_death(func(player, data))
+	* data is player data (see below)
+	* return award name or null
+* awards.register_on_chat(func(player, data))
+	* data is player data (see below)
+	* return award name or null
+* awards.register_on_join(func(player, data)
+	* data is player data (see below)
+	* return award name or null
 
 
-Player Data
-===========
+# Player Data
 
 A list of data referenced/hashed by the player's name.
 * player name

triggers.lua

@@ -1,181 +1,148 @@
 -- AWARDS
---    by Rubenwardy
--------------------------------------------------------
--- this is the trigger handler file for the awards mod
--------------------------------------------------------
+--
+-- Copyright (C) 2013-2015 rubenwardy
+-- This program is free software; you can redistribute it and/or modify
+-- it under the terms of the GNU Lesser General Public License as published by
+-- the Free Software Foundation; either version 2.1 of the License, or
+-- (at your option) any later version.
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Lesser General Public License for more details.
+-- You should have received a copy of the GNU Lesser General Public License along
+-- with this program; if not, write to the Free Software Foundation, Inc.,
+-- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+--
 
--- Function and table holders for Triggers
-awards.onDig = {}
-awards.onPlace = {}
-awards.onCraft = {}
-awards.onChat = {}
-awards.onDeath = {}
-awards.onJoin = {}
+awards.register_trigger("dig", function(def)
+	local tmp = {
+		award  = def.name,
+		node   = def.trigger.node,
+		target = def.trigger.target
+	}
+	table.insert(awards.on.dig, tmp)
+end)
+
+awards.register_trigger("place", function(def)
+	local tmp = {
+		award  = def.name,
+		node   = def.trigger.node,
+		target = def.trigger.target
+	}
+	table.insert(awards.on.place, tmp)
+end)
+
+awards.register_trigger("death", function(def)
+	local tmp = {
+		award  = def.name,
+		target = def.trigger.target
+	}
+	table.insert(awards.on.death, tmp)
+end)
+
+awards.register_trigger("chat", function(def)
+	local tmp = {
+		award  = def.name,
+		target = def.trigger.target
+	}
+	table.insert(awards.on.chat, tmp)
+end)
+
+awards.register_trigger("join", function(def)
+	local tmp = {
+		award  = def.name,
+		target = def.trigger.target
+	}
+	table.insert(awards.on.join, tmp)
+end)
+
+awards.register_trigger("craft", function(def)
+	local tmp = {
+		award  = def.name,
+		item   = def.trigger.item,
+		target = def.trigger.target
+	}
+	table.insert(awards.on.craft, tmp)
+end)
+
+-- Backwards compatibility
+awards.register_onDig   = awards.register_on_dig
+awards.register_onPlace = awards.register_on_place
+awards.register_onDeath = awards.register_on_death
+awards.register_onChat  = awards.register_on_chat
+awards.register_onJoin  = awards.register_on_join
+awards.register_onCraft = awards.register_on_craft
 
 -- Trigger Handles
 minetest.register_on_dignode(function(pos, oldnode, digger)
 	if not digger or not pos or not oldnode then
 		return
 	end
-	local nodedug = string.split(oldnode.name, ":")
-	if #nodedug ~= 2 then
-		--minetest.log("error","Awards mod: "..oldnode.name.." is in wrong format!")
+
+	local data = awards.players[digger:get_player_name()]
+	if not awards.increment_item_counter(data, "count", oldnode.name) then
 		return
 	end
-	local mod = nodedug[1]
-	local item = nodedug[2]
-	local playern = digger:get_player_name()
-
-	if (not playern or not nodedug or not mod or not item) then
-		return
-	end
-	awards.assertPlayer(playern)
-	awards.tbv(awards.players[playern].count, mod)
-	awards.tbv(awards.players[playern].count[mod], item, 0)
-
-	-- Increment counter
-	awards.players[playern].count[mod][item]=awards.players[playern].count[mod][item] + 1
-
-	-- Run callbacks and triggers
-	local player=digger
-	local data=awards.players[playern]
-	for i=1,# awards.onDig do
-		local res = nil
-		if type(awards.onDig[i]) == "function" then
-			-- Run trigger callback
-			res = awards.onDig[i](player,data)
-		elseif type(awards.onDig[i]) == "table" then
-			-- Handle table trigger
-			if not awards.onDig[i].node or not awards.onDig[i].target or not awards.onDig[i].award then
-				-- table running failed!
-				print("[ERROR] awards - onDig trigger "..i.." is invalid!")
-			else
-				-- run the table
-				local tnodedug = string.split(awards.onDig[i].node, ":")
+	awards.run_trigger_callbacks(digger, data, "dig", function(entry)
+		if entry.node and entry.target then
+			local tnodedug = string.split(entry.node, ":")
 			local tmod = tnodedug[1]
 			local titem = tnodedug[2]
-				if tmod==nil or titem==nil or not data.count[tmod] or not data.count[tmod][titem] then
+			if not tmod or not titem or not data.count[tmod] or not data.count[tmod][titem] then
 				-- table running failed!
-				elseif data.count[tmod][titem] > awards.onDig[i].target-1 then
-					res=awards.onDig[i].award
-				end
-			end
-		end
-
-		if res then
-			awards.give_achievement(playern,res)
+			elseif data.count[tmod][titem] > entry.target-1 then
+				return entry.award
 			end
 		end
 	end)
+end)
 
 minetest.register_on_placenode(function(pos, node, digger)
 	if not digger or not pos or not node or not digger:get_player_name() or digger:get_player_name()=="" then
 		return
 	end
-	local nodedug = string.split(node.name, ":")
-	if #nodedug ~= 2 then
-		--minetest.log("error","Awards mod: "..node.name.." is in wrong format!")
+	local data = awards.players[digger:get_player_name()]
+	if not awards.increment_item_counter(data, "place", node.name) then
 		return
 	end
-	local mod=nodedug[1]
-	local item=nodedug[2]
-	local playern = digger:get_player_name()
 
-	-- Run checks
-	if (not playern or not nodedug or not mod or not item) then
-		return
-	end
-	awards.assertPlayer(playern)
-	awards.tbv(awards.players[playern].place, mod)
-	awards.tbv(awards.players[playern].place[mod], item, 0)
-
-	-- Increment counter
-	awards.players[playern].place[mod][item] = awards.players[playern].place[mod][item] + 1
-
-	-- Run callbacks and triggers
-	local player = digger
-	local data = awards.players[playern]
-	for i=1,# awards.onPlace do
-		local res = nil
-		if type(awards.onPlace[i]) == "function" then
-			-- Run trigger callback
-			res = awards.onPlace[i](player,data)
-		elseif type(awards.onPlace[i]) == "table" then
-			-- Handle table trigger
-			if not awards.onPlace[i].node or not awards.onPlace[i].target or not awards.onPlace[i].award then
-				print("[ERROR] awards - onPlace trigger "..i.." is invalid!")
-			else
-				-- run the table
-				local tnodedug = string.split(awards.onPlace[i].node, ":")
+	awards.run_trigger_callbacks(digger, data, "place", function(entry)
+		if entry.node and entry.target then
+			local tnodedug = string.split(entry.node, ":")
 			local tmod = tnodedug[1]
 			local titem = tnodedug[2]
-				if tmod==nil or titem==nil or not data.place[tmod] or not data.place[tmod][titem] then
+			if not tmod or not titem or not data.place[tmod] or not data.place[tmod][titem] then
 				-- table running failed!
-				elseif data.place[tmod][titem] > awards.onPlace[i].target-1 then
-					res = awards.onPlace[i].award
-				end
-			end
-		end
-
-		if res then
-			awards.give_achievement(playern,res)
+			elseif data.place[tmod][titem] > entry.target-1 then
+				return entry.award
 			end
 		end
 	end)
+end)
 
 minetest.register_on_craft(function(itemstack, player, old_craft_grid, craft_inv)
 	if not player or not itemstack then
 		return
 	end
-	local itemcrafted = string.split(itemstack:get_name(), ":")
-	if #itemcrafted ~= 2 then
-		--minetest.log("error","Awards mod: "..itemstack:get_name().." is in wrong format!")
+
+	local data = awards.players[player:get_player_name()]
+	if not awards.increment_item_counter(data, "craft", itemstack:get_name()) then
 		return
 	end
-	local mod = itemcrafted[1]
-	local item = itemcrafted[2]
-	local playern = player:get_player_name()
 
-	if (not playern or not itemcrafted or not mod or not item) then
-		return
-	end
-	awards.assertPlayer(playern)
-	awards.tbv(awards.players[playern].craft, mod)
-	awards.tbv(awards.players[playern].craft[mod], item, 0)
-
-	-- Increment counter
-	awards.players[playern].craft[mod][item]=awards.players[playern].craft[mod][item] + 1
-
-	-- Run callbacks and triggers
-	local data=awards.players[playern]
-	for i=1,# awards.onCraft do
-		local res = nil
-		if type(awards.onCraft[i]) == "function" then
-			-- Run trigger callback
-			res = awards.onDig[i](player,data)
-		elseif type(awards.onCraft[i]) == "table" then
-			-- Handle table trigger
-			if not awards.onCraft[i].item or not awards.onCraft[i].target or not awards.onCraft[i].award then
-				-- table running failed!
-				print("[ERROR] awards - onCraft trigger "..i.." is invalid!")
-			else
-				-- run the table
-				local titemcrafted = string.split(awards.onCraft[i].item, ":")
+	awards.run_trigger_callbacks(player, data, "craft", function(entry)
+		if entry.item and entry.target then
+			local titemcrafted = string.split(entry.item, ":")
 			local tmod = titemcrafted[1]
 			local titem = titemcrafted[2]
-				if tmod==nil or titem==nil or not data.craft[tmod] or not data.craft[tmod][titem] then
+			if not tmod or not titem or not data.craft[tmod] or not data.craft[tmod][titem] then
 				-- table running failed!
-				elseif data.craft[tmod][titem] > awards.onCraft[i].target-1 then
-					res=awards.onCraft[i].award
-				end
-			end
-		end
-
-		if res then
-			awards.give_achievement(playern,res)
+			elseif data.craft[tmod][titem] > entry.target-1 then
+				return entry.award
 			end
 		end
 	end)
+end)
 
 minetest.register_on_dieplayer(function(player)
 	-- Run checks
@@ -191,23 +158,13 @@ minetest.register_on_dieplayer(function(player)
 	-- Increment counter
 	data.deaths = data.deaths + 1
 
-	-- Run callbacks and triggers
-	for _,trigger in pairs(awards.onDeath) do
-		local res = nil
-		if type(trigger) == "function" then
-			res = trigger(player,data)
-		elseif type(trigger) == "table" then
-			if trigger.target and trigger.award then
-				if data.deaths and data.deaths >= trigger.target then
-					res = trigger.award
-				end
-			end
-		end
-		if res ~= nil then
-			awards.give_achievement(name,res)
-		end
+	awards.run_trigger_callbacks(player, data, "death", function(entry)
+		if entry.target and entry.award and data.deaths and
+				data.deaths >= entry.target then
+			return entry.award
 		end
 	end)
+end)
 
 minetest.register_on_joinplayer(function(player)
 	-- Run checks
@@ -223,23 +180,13 @@ minetest.register_on_joinplayer(function(player)
 	-- Increment counter
 	data.joins = data.joins + 1
 
-	-- Run callbacks and triggers
-	for _,trigger in pairs(awards.onJoin) do
-		local res = nil
-		if type(trigger) == "function" then
-			res = trigger(player,data)
-		elseif type(trigger) == "table" then
-			if trigger.target and trigger.award then
-				if data.joins and data.joins >= trigger.target then
-					res = trigger.award
-				end
-			end
-		end
-		if res ~= nil then
-			awards.give_achievement(name,res)
-		end
+	awards.run_trigger_callbacks(player, data, "join", function(entry)
+		if entry.target and entry.award and data.joins and
+				data.joins >= entry.target then
+			return entry.award
 		end
 	end)
+end)
 
 minetest.register_on_chat_message(function(name, message)
 	-- Run checks
@@ -256,29 +203,10 @@ minetest.register_on_chat_message(function(name, message)
 	-- Increment counter
 	data.chats = data.chats + 1
 
-	-- Run callbacks and triggers	
-	for _,trigger in pairs(awards.onChat) do
-		local res = nil
-		if type(trigger) == "function" then
-			res = trigger(player,data)
-		elseif type(trigger) == "table" then
-			if trigger.target and trigger.award then
-				if data.chats and data.chats >= trigger.target then
-					res = trigger.award
-				end
-			end
-		end
-		if res ~= nil then
-			awards.give_achievement(name,res)
-		end
+	awards.run_trigger_callbacks(player, data, "chat", function(entry)
+		if entry.target and entry.award and data.chats and
+				data.chats >= entry.target then
+			return entry.award
 		end
 	end)
-
-minetest.register_on_newplayer(function(player)
-	local playern = player:get_player_name()
-	awards.assertPlayer(playern)
-end)
-
-minetest.register_on_shutdown(function()
-	awards.save()
 end)