Upload files to 'mods/craftguide'
This commit is contained in:
parent
659e211db6
commit
b9e8637a7b
|
@ -0,0 +1,22 @@
|
||||||
|
## Files related to minetest development cycle
|
||||||
|
/*.patch
|
||||||
|
# GNU Patch reject file
|
||||||
|
*.rej
|
||||||
|
|
||||||
|
## Editors and Development environments
|
||||||
|
*~
|
||||||
|
*.swp
|
||||||
|
*.bak*
|
||||||
|
*.orig
|
||||||
|
# Vim
|
||||||
|
*.vim
|
||||||
|
# Kate
|
||||||
|
.*.kate-swp
|
||||||
|
.swp.*
|
||||||
|
# Eclipse (LDT)
|
||||||
|
.project
|
||||||
|
.settings/
|
||||||
|
.buildpath
|
||||||
|
.metadata
|
||||||
|
# Idea IDE
|
||||||
|
.idea/*
|
|
@ -0,0 +1,18 @@
|
||||||
|
unused_args = false
|
||||||
|
allow_defined_top = true
|
||||||
|
|
||||||
|
read_globals = {
|
||||||
|
"minetest",
|
||||||
|
"default",
|
||||||
|
"sfinv",
|
||||||
|
"sfinv_buttons",
|
||||||
|
"vector",
|
||||||
|
"string",
|
||||||
|
"table",
|
||||||
|
"ItemStack",
|
||||||
|
}
|
||||||
|
|
||||||
|
globals = {
|
||||||
|
"craftguide",
|
||||||
|
"core",
|
||||||
|
}
|
|
@ -0,0 +1,214 @@
|
||||||
|
## API
|
||||||
|
|
||||||
|
### Custom recipes
|
||||||
|
|
||||||
|
Custom recipes are nonconventional crafts outside the main crafting grid.
|
||||||
|
They can be registered in-game dynamically and have a size beyond 3x3 items.
|
||||||
|
|
||||||
|
**Note:** the registration format differs from the default registration format in everything.
|
||||||
|
The width is automatically calculated depending where you place the commas. Look at the examples attentively.
|
||||||
|
|
||||||
|
#### Registering a custom crafting type (example)
|
||||||
|
|
||||||
|
```Lua
|
||||||
|
craftguide.register_craft_type("digging", {
|
||||||
|
description = "Digging",
|
||||||
|
icon = "default_tool_steelpick.png",
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Registering a custom crafting recipe (examples)
|
||||||
|
|
||||||
|
```Lua
|
||||||
|
craftguide.register_craft({
|
||||||
|
type = "digging",
|
||||||
|
result = "default:cobble 2",
|
||||||
|
items = {"default:stone"},
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
```Lua
|
||||||
|
craftguide.register_craft({
|
||||||
|
result = "default:cobble 16",
|
||||||
|
items = {
|
||||||
|
"default:stone, default:stone, default:stone",
|
||||||
|
"default:stone, , default:stone",
|
||||||
|
"default:stone, default:stone, default:stone",
|
||||||
|
}
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
Recipes can be registered in a Minecraft-like way:
|
||||||
|
|
||||||
|
```Lua
|
||||||
|
craftguide.register_craft({
|
||||||
|
grid = {
|
||||||
|
"X #",
|
||||||
|
" ## ",
|
||||||
|
"X#X#",
|
||||||
|
"X X",
|
||||||
|
},
|
||||||
|
key = {
|
||||||
|
['#'] = "default:wood",
|
||||||
|
['X'] = "default:glass",
|
||||||
|
},
|
||||||
|
result = "default:mese 3",
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
Multiples recipes can also be registered:
|
||||||
|
|
||||||
|
```Lua
|
||||||
|
craftguide.register_craft({
|
||||||
|
{
|
||||||
|
result = "default:mese",
|
||||||
|
items = {
|
||||||
|
"default:mese_crystal, default:mese_crystal",
|
||||||
|
"default:mese_crystal, default:mese_crystal",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
big = {
|
||||||
|
result = "default:mese 4",
|
||||||
|
items = {
|
||||||
|
"default:mese_crystal, default:mese_crystal",
|
||||||
|
"default:mese_crystal, default:mese_crystal",
|
||||||
|
"default:mese_crystal, default:mese_crystal",
|
||||||
|
"default:mese_crystal, default:mese_crystal",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
Recipes can be registered from a given URL containing a JSON file (HTTP support is required¹):
|
||||||
|
|
||||||
|
```Lua
|
||||||
|
craftguide.register_craft({
|
||||||
|
url = "https://raw.githubusercontent.com/minetest-mods/craftguide/master/test.json"
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Recipe filters
|
||||||
|
|
||||||
|
Recipe filters can be used to filter the recipes shown to players. Progressive
|
||||||
|
mode is implemented as a recipe filter.
|
||||||
|
|
||||||
|
#### `craftguide.add_recipe_filter(name, function(recipes, player))`
|
||||||
|
|
||||||
|
Adds a recipe filter with the given name. The filter function should return the
|
||||||
|
recipes to be displayed, given the available recipes and an `ObjectRef` to the
|
||||||
|
user. Each recipe is a table of the form returned by
|
||||||
|
`minetest.get_craft_recipe`.
|
||||||
|
|
||||||
|
Example function to hide recipes for items from a mod called "secretstuff":
|
||||||
|
|
||||||
|
```lua
|
||||||
|
craftguide.add_recipe_filter("Hide secretstuff", function(recipes)
|
||||||
|
local filtered = {}
|
||||||
|
for _, recipe in ipairs(recipes) do
|
||||||
|
if recipe.output:sub(1,12) ~= "secretstuff:" then
|
||||||
|
filtered[#filtered + 1] = recipe
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
return filtered
|
||||||
|
end)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `craftguide.set_recipe_filter(name, function(recipe, player))`
|
||||||
|
|
||||||
|
Removes all recipe filters and adds a new one.
|
||||||
|
|
||||||
|
#### `craftguide.remove_recipe_filter(name)`
|
||||||
|
|
||||||
|
Removes the recipe filter with the given name.
|
||||||
|
|
||||||
|
#### `craftguide.get_recipe_filters()`
|
||||||
|
|
||||||
|
Returns a map of recipe filters, indexed by name.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Search filters
|
||||||
|
|
||||||
|
Search filters are used to perform specific searches inside the search field.
|
||||||
|
They can be used like so: `<optional name>+<filter name>=<value1>,<value2>,<...>`
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
|
||||||
|
- `+groups=cracky,crumbly`: search for groups `cracky` and `crumbly` in all items.
|
||||||
|
- `sand+groups=falling_node`: search for group `falling_node` for items which contain `sand` in their names.
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
- If `optional name` is omitted, the search filter will apply to all items, without pre-filtering.
|
||||||
|
- Filters can be combined.
|
||||||
|
- The `groups` filter is currently implemented by default.
|
||||||
|
|
||||||
|
#### `craftguide.add_search_filter(name, function(item, values))`
|
||||||
|
|
||||||
|
Adds a search filter with the given name.
|
||||||
|
The search function should return a boolean value (whether the given item should be listed or not).
|
||||||
|
|
||||||
|
Example function to show items which contain at least a recipe of given width(s):
|
||||||
|
|
||||||
|
```lua
|
||||||
|
craftguide.add_search_filter("widths", function(item, widths)
|
||||||
|
local has_width
|
||||||
|
local recipes = recipes_cache[item]
|
||||||
|
|
||||||
|
if recipes then
|
||||||
|
for i = 1, #recipes do
|
||||||
|
local recipe_width = recipes[i].width
|
||||||
|
for j = 1, #widths do
|
||||||
|
local width = tonumber(widths[j])
|
||||||
|
if width == recipe_width then
|
||||||
|
has_width = true
|
||||||
|
break
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
return has_width
|
||||||
|
end)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `craftguide.remove_search_filter(name)`
|
||||||
|
|
||||||
|
Removes the search filter with the given name.
|
||||||
|
|
||||||
|
#### `craftguide.get_search_filters()`
|
||||||
|
|
||||||
|
Returns a map of search filters, indexed by name.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Miscellaneous
|
||||||
|
|
||||||
|
#### `craftguide.show(player_name, item, show_usages)`
|
||||||
|
|
||||||
|
Opens the Crafting Guide with the current filter applied.
|
||||||
|
|
||||||
|
* `player_name`: string param.
|
||||||
|
* `item`: optional, string param. If set, this item is pre-selected. If the item does not exist or has no recipe, use the player's previous selection. By default, player's previous selection is used
|
||||||
|
* `show_usages`: optional, boolean param. If true, show item usages.
|
||||||
|
|
||||||
|
#### `craftguide.group_stereotypes`
|
||||||
|
|
||||||
|
This is the table indexing the item groups by stereotypes.
|
||||||
|
You can add a stereotype like so:
|
||||||
|
|
||||||
|
```Lua
|
||||||
|
craftguide.group_stereotypes.radioactive = "mod:item"
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `craftguide.export_url`
|
||||||
|
|
||||||
|
If set, the mod will export all the cached recipes and usages in a JSON format
|
||||||
|
to the given URL (HTTP support is required¹).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**¹** Add `craftguide` to the `secure.http_mods` or `secure.trusted_mods` setting in `minetest.conf`.
|
File diff suppressed because it is too large
Load Diff
|
@ -0,0 +1,61 @@
|
||||||
|
License of source code
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2015-2020 Jean-Patrick Guerrero and contributors.
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in
|
||||||
|
all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
|
THE SOFTWARE.
|
||||||
|
|
||||||
|
|
||||||
|
Licenses of media (textures)
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
Copyright © Diego Martínez (kaeza): craftguide_*_icon.png (CC BY-SA 3.0)
|
||||||
|
|
||||||
|
paramat (CC BY-SA 3.0):
|
||||||
|
sfinv_crafting_arrow.png - derived from a texture by BlockMen (CC BY-SA 3.0)
|
||||||
|
|
||||||
|
You are free to:
|
||||||
|
Share — copy and redistribute the material in any medium or format.
|
||||||
|
Adapt — remix, transform, and build upon the material for any purpose, even commercially.
|
||||||
|
The licensor cannot revoke these freedoms as long as you follow the license terms.
|
||||||
|
|
||||||
|
Under the following terms:
|
||||||
|
|
||||||
|
Attribution — You must give appropriate credit, provide a link to the license, and
|
||||||
|
indicate if changes were made. You may do so in any reasonable manner, but not in any way
|
||||||
|
that suggests the licensor endorses you or your use.
|
||||||
|
|
||||||
|
ShareAlike — If you remix, transform, or build upon the material, you must distribute
|
||||||
|
your contributions under the same license as the original.
|
||||||
|
|
||||||
|
No additional restrictions — You may not apply legal terms or technological measures that
|
||||||
|
legally restrict others from doing anything the license permits.
|
||||||
|
|
||||||
|
Notices:
|
||||||
|
|
||||||
|
You do not have to comply with the license for elements of the material in the public
|
||||||
|
domain or where your use is permitted by an applicable exception or limitation.
|
||||||
|
No warranties are given. The license may not give you all of the permissions necessary
|
||||||
|
for your intended use. For example, other rights such as publicity, privacy, or moral
|
||||||
|
rights may limit how you use the material.
|
||||||
|
|
||||||
|
For more details:
|
||||||
|
http://creativecommons.org/licenses/by-sa/3.0/
|
Loading…
Reference in New Issue