You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
BuckarooBanzay dea2377a61 only display level up if hud is enabled 8 months ago
.github/workflows github action 1 year ago
sounds proper hud / rank congrats 2 years ago
textures cleanup 1 year ago
.luacheckrc don't reward woodcutting 11 months ago
LICENSE.txt textures / skeleton 2 years ago
README.md optional discord webhook 1 year ago
areas.lua fix typo 9 months ago
builtin.lua don't reward woodcutting 11 months ago
chatcmd.lua luacheck 1 year ago
entities.lua configurable entity props 1 year ago
functions.lua only display level up if hud is enabled 8 months ago
globalstep.lua luacheck 1 year ago
highscore.lua luacheck 1 year ago
hooks.lua add hooks 1 year ago
hud.lua only display level up if hud is enabled 8 months ago
init.lua only display level up if hud is enabled 8 months ago
integration_test.lua travis tests 1 year ago
json.lua luacheck 1 year ago
mobs.lua luacheck 1 year ago
mod.conf don't reward woodcutting 11 months ago
privs.lua bugfix 1 year ago
protector.lua additional check 1 year ago
ranks.lua check if entities enabled before registering rank entity 10 months ago
stats.lua [gs]et_attribute -> meta methods 1 year ago
test.sh test script for areas 1 year ago
webhook.lua optional discord webhook 1 year ago
xpgate.lua xp gate mode 1 year ago

README.md

Minetest XP mod (xp_redo)

Minetest mod for player experience management (xp) It adds an xp counter per player and ranks according to your xp level. The xp level, your rank and a progress bar to the next rank will show up in your hud. On every rank level up you get a award-like notification. There is also a xpgate block which, when placed under a wooden door will only allow players with a certain xp level to go through.

Installation

  • Unzip the archive, rename the folder to xp_redo and place it in ..minetest/mods/

  • GNU/Linux: If you use a system-wide installation place it in ~/.minetest/mods/.

  • If you only want this to be used in a single world, place the folder in ..worldmods/ in your world directory.

For further information or help, see:
https://wiki.minetest.net/Installing_Mods

Privileges

  • givexp: Manage XP of your users.

Commands

Add or remove (amount with negative sign) XP from a user:

/givexp (username) (amount)

Example:

Give player somedude 200 XP points:

/givexp somedude 200

Remove 100 XP points from player somedude:

/givexp somedude -100

Dependencies

  • default

Optional dependencies

  • doors
  • mobs_redo
  • mobs_animal
  • mobs_monster

Areas integration

There are additional commands available if the areas mod is available:

  • /area_xp_set_min <id> <xp> assign a min-value that a aplayer needs to interact with the area
  • /area_xp_get_min <id> returns the min-value, if any for that area

For this to work the area has to be opened with /area_open <id>

Builtin XP events

Digging

Every node dig gives you 1 xp point

Punching

Every mob punch gives you the amount of damage on the mob in xp

Ranks

See:

Settings

  • xp_redo.discord.webhook_url discord webhook url (optional)
  • xp_redo.discord.texture_baseurl baseurl for the webhook avatar image (optional)

For the webhook, the mod has to be in the secure.http_mods setting:

minetest.conf

secure.http_mods = xp_redo

Lua api

Ranks

xp_redo.register_rank(rankDef)

rankDef = {
	name = "Rank name",
	icon = "myicon.png" -- Should fit withing the background icon (16x32px)
	color = {r=255, g=255, b=255}, -- Player name tag color
	xp = 100 -- xp threshold
}

ranks are held in xp_redo.ranks as a table.

xp_redo.get_rank(xpAmount)

Returns the rankDef for given xp amount

Hooks

xp_redo.register_hook({
  xp_change = function(playername, xp)
    -- new xp value
  end,

  rank_change = function(playername, xp, rank)
    -- new rank
  end,

  stat_change = function(playername, name, value)
    -- see stats.lua
  end
})

XP

xp_redo.get_xp(playername)

Returns the xp level for given playername (always a number).

xp_redo.add_xp(playername, xp)

Adds the amount of xp to given playername (can be negative for xp removal).

License

See LICENSE.txt

Pull requests / bugs

I’m happy for any bug reports or pull requests (code and textures).

TODO / Ideas

  • Scoreboard (block)
  • More doors
  • Door-teleport alternative
  • XP Regions
  • XP entities/items