From 903aa691bf4aff3c565d8316987e22f8814787da Mon Sep 17 00:00:00 2001 From: Jean-Patrick Guerrero Date: Thu, 31 Dec 2020 02:50:22 +0100 Subject: [PATCH] Update README --- README.md | 17 ++++++++++++++- license.txt | 59 ----------------------------------------------------- mod.conf | 2 +- 3 files changed, 17 insertions(+), 61 deletions(-) delete mode 100644 license.txt diff --git a/README.md b/README.md index 6bdb0ed..766f0cd 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # i3 -#### A next-gen inventory for Minetest +#### A tiling inventory for Minetest + +`i3` is a tiling inventory for Minetest with a modern UI using the latest technologies of the Minetest engine. +It offers everything what [`craftguide`](https://github.com/minetest-mods/craftguide) can do, with an inventory on top of that. + +This inventory features a **Progressive Mode**. +This mode is a Terraria-like system that shows recipes you can craft from items you ever had in your inventory. +To enable it: `i3_progressive_mode = true` in `minetest.conf`. + +For developers, `i3` also has a [modding API](https://github.com/minetest-mods/i3/blob/master/API.md). + +This mod also supports [`3d_armor`](https://github.com/minetest-mods/3d_armor) for a nice player model preview. + +Love this mod? Donations are appreciated: https://www.paypal.me/jpg84240 + +![Preview](https://user-images.githubusercontent.com/7883281/103390081-c619b480-4b12-11eb-9993-c35787cc6b61.png) diff --git a/license.txt b/license.txt deleted file mode 100644 index 91dc864..0000000 --- a/license.txt +++ /dev/null @@ -1,59 +0,0 @@ -License of source code ----------------------- - -The MIT License (MIT) - -Copyright (c) 2015-present 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) ----------------------------- - -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/ diff --git a/mod.conf b/mod.conf index c1c28c2..9885f60 100644 --- a/mod.conf +++ b/mod.conf @@ -1,3 +1,3 @@ name = i3 -description = Next-Gen inventory for Minetest +description = Tiling inventory for Minetest optional_depends = 3d_armor