[abandoned] [Mod] Override [override] (v0.2)

[AntumDeluge]

this mod is abandoned, for removing/replacing entities, nodes, & items at server start see cleaner

Override Mod

Description:

A mod to simplify overriding craft items. Single or multiple items can be overridden with another pre-registered item using override.replaceItems. Single or multiple items can be overridden with a newly created item using override.overrideItems.

Supported object types:

• items
• craft items
• nodes
• tools (works, but not thoroughly tested)
• ores (untested)

(overriding other types of objects may be supported in the future)

Global functions:

• override.replaceItems (items, target)
  • Unregisters items & set names as aliases for another existing item.
  • items: List of item names to be overridden (can be string for single item override).
  • target: Item name of aliases' target.
• override.overrideItems (name, def)
  • Unregisters craft items & registers names as aliases for new item.
  • name: Name of new item.
  • def: Item definition (see: core.register_craftitem) with additional overrides field (list of item names to be overridden or string for single item override).

Examples:

To override multiple items with an item that is already registered, say default:diamond for example, call:

Code: Select all

override.replaceItems({"mod1:diamond", "mod2:diamond", ...}, "default:diamond")

To override multiple items with a newly created one, call:

Code: Select all

override.overrideItems("modname:item", {
    overrides = {"mod1:item", "mod2:item", ...},
    description = "New item",
    wield_image = "modname_item.png",
    ...
}

Pre-existing items can be overridden using a file named overrides.txt in the world path. Each new line in the file represents a call to overrides.replaceItems. The formatting is as follows:

Code: Select all

alias1,alias2,...;target

In the example above, each existing item (alias1, alias2, etc.) will be unregistered & re-added as an alias of target.

Licensing:

• MIT

Requirements:

• Depends: none

Links:

• Git repo
• API

Releases:

• v0.2
• master

[Desour]

There's a minetest.override_item(name, redefinition) function (https://github.com/minetest/minetest/bl ... .txt#L2247).
You shouldn't only look at the dev wiki.

[Linuxdirk]

You shouldn't only look at the dev wiki.

It even is in the dev wiki.

http://dev.minetest.net/minetest.override_item

[AntumDeluge]

I believe this mod is a little different though, because it allows overriding multiple items at once & redefines them as aliases. Perhaps the semantics between override & redefine are confusing? I would consider the functionality of minetest.override_item to be more like redefining. Though, override works for that too.

Overriding multiple items as aliases of another is useful when there are multiple mods that use similar items. I'll try to think of a good example. At the moment I can only think of default:diamond & gems:diamond. I believe this mod makes it easy to unify similar items into one.

If the item that you want to use already exists, say default:diamond, just call:

Code: Select all

override.replaceItems({"mod1:diamond", "mod2:diamond", ...}, "default:diamond")

If you want to create a new item to override others, call:

Code: Select all

override.overrideItems("modname:diamond", {
    overrides = {"default:diamond", "gems:diamond",},
    description = "New diamond item",
    wield_image = "modname_diamond.png",
    ...
}

Also, I want to try to make this mod capable of overriding other object types as well.

[azekill_DIABLO]

alias?

[AntumDeluge]

alias?

So, if you call:

Code: Select all

override.replaceItems("gems:diamond", "default:diamond")

gems:diamond is first unregistered with:

Code: Select all

core.unregister_item("gems:diamond")

Then, it is re-added as an alias of default:diamond using:

Code: Select all

core.register_alias("gems:diamond", "default:diamond")

The same goes for multiple items:

Code: Select all

override.replaceItems({"mod1:diamond", "mod2:diamond",}, "default:diamond")

Each of mod1:diamond & mod2:diamond is first unregistered, then re-added as aliases of default:diamond.

So, in this mod, you're not just redefining an item. You are replacing it with either an existing or new one.

[rubenwardy]

override.replaceItems("gems:diamond", "default:diamond")

Could be done with

minetest.register_alias_force("gems: diamond", "default:diamond")

Nice mod anyway, to allow doing this with lists

[AntumDeluge]

override.replaceItems("gems:diamond", "default:diamond")

Could be done with

minetest.register_alias_force("gems: diamond", "default:diamond")

I had forgotten about force.

[Wuzzy]

This mod seems pointless. It's just a wrapper mod which doesn't add any new functionality.

If you think the syntax of current Lua API is lacking, just fix Minetest.

[AntumDeluge]

I would prefer this functionality to be in the Minetest core, but I'm not a very good C++ coder. I may put in a feature request though.


--- Edit ---

Now can read from overrides.txt in world path:

override @ Git commit 35ab53c

[AntumDeluge]

UPDATES:

• Fixed reading entire overrides.txt file: override @ Git commit d19b03c
• overrides.txt isn't read until server is finished loading: override @ Git commit 3b44e13

[azekill_DIABLO]

+1