Clarify license and cleanup (#61)

.github/pull_request_template.md

@@ -1,13 +1,17 @@
-<!-- If it fixes a reported issue, specify the issue number below -->
+<!-- markdownlint-disable first-line-heading -->
+<!-- If it fixes a reported issue, specify the issue number below and remove the backticks. -->
 
-Closes #
+<!-- Closes # -->
 Things added/changed:
+
 <!-- Specify what the PR adds, fixes, or does -->
-- 
-- 
-- 
+
+-
+-
+-
 
 ## To do
+
 Draft PR / Ready for review.
 <!-- Choose one of the options above -->
 
@@ -16,4 +20,5 @@ Draft PR / Ready for review.
 - [ ] Vulnerability
 
 ## How to test
+
 <!-- Please add testing instructions here -->

.luacheckrc

@@ -1,6 +1,6 @@
 unused_args = false
 allow_defined_top = true
-max_line_length = 999
+max_line_length = false
 
 globals = {
 	"tp"

AUTHORS.md

@@ -0,0 +1,15 @@
+# Authors
+
+## Source code
+
+[ChaosWormz](https://github.com/ChaosWormz) and contributors ([GNU LGPLv2.1+](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html)).
+
+## Media (textures and sounds)
+
+[David Leal](https://github.com/Panquesito7) ([CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)):
+
+- [`tpr_warp.ogg`](https://github.com/minetest-mods/teleport-request/blob/HEAD/sounds/tpr_warp.ogg)
+
+[Robbie Ferguson](https://github.com/Cat5TV) ([CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/)):
+
+- [`tpr_portal_parti.png`](https://github.com/minetest-mods/teleport-request/blob/HEAD/textures/tpr_portal_parti.png)

CONTRIBUTING.md

@@ -1,8 +1,11 @@
 # Contributing
 
-Welcome to the [Teleport Request](https://github.com/minetest-mods/teleport-request) mod! Before contributing, **please make sure** you have read the whole guidelines mentioned below. If you have any doubts about these guidelines, please open [an issue](https://github.com/minetest-mods/teleport-request/issues/new), and clearly state your concerns.
+Welcome to the [Teleport Request](https://github.com/minetest-mods/teleport-request) mod! Before contributing, **please make sure** you have read the guidelines below.\
+If you have any doubts about these guidelines, please open [an issue](https://github.com/minetest-mods/teleport-request/issues/new), and clearly state your concerns.
 
-## Creating an issue
+Thank you for your interest in contributing!
+
+## Creating issues
 
 - Why did you open the issue? What is the reason?
 - You must explain clearly the issue you are experiencing.
@@ -10,11 +13,11 @@ Welcome to the [Teleport Request](https://github.com/minetest-mods/teleport-requ
 - You **must** be polite (while commenting on or opening an issue).
 - Review your issue before submitting it.
 
-## Creating a pull request
+## Creating pull requests
 
 - First, think if your feature/bugfix/etc. is needed before opening it.
-- Explain clearly what it does, what does it change, or any additional information.
-- You must create a new branch for your new features or bugfixes.
+- Explain clearly what it does, what it changes, or any additional information.
+- You must create a new branch for your new features or bug fixes.
 - You **must** be polite (while commenting on or opening a pull request).
 - Review before opening the pull request (if it has any issues, a pending change you forgot about, etc.).
 - You must enable the checkbox `Allow edits from maintainers`.

COPYING.LESSER

@@ -1,5 +1,3 @@
-Copyright (C) ChaosWormz 2014-2023 and contributors
-
                   GNU LESSER GENERAL PUBLIC LICENSE
                        Version 2.1, February 1999
 
@@ -57,7 +55,7 @@ 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
@@ -113,7 +111,7 @@ 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
 
@@ -160,7 +158,7 @@ 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
@@ -218,7 +216,7 @@ 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.
@@ -269,7 +267,7 @@ Library will still fall under Section 6.)
 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
@@ -331,7 +329,7 @@ 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
@@ -372,7 +370,7 @@ 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
@@ -424,7 +422,7 @@ 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
@@ -458,7 +456,7 @@ 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
@@ -487,8 +485,7 @@ convey the exclusion of warranty; and each file should have at least the
 
     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
+    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.
 
@@ -497,8 +494,7 @@ 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.
+  library `Frob' (a library for tweaking knobs) written by James Random Hacker.
 
   <signature of Ty Coon>, 1 April 1990
   Ty Coon, President of Vice

LICENSE.txt

@@ -0,0 +1,95 @@
+License of source code
+----------------------
+
+GNU Lesser General Public License, version 2.1
+Copyright (C) 2014-2024 ChaosWormz and contributors
+
+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
+
+Licenses of media (textures and sounds)
+---------------------------------------
+
+Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)
+Copyright (C) 2020 David Leal (halfpacho@gmail.com)
+
+You are free to:
+
+Share — copy and redistribute the material in any medium or format for any
+purpose, even commercially.
+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:
+https://creativecommons.org/licenses/by-sa/4.0/
+
+-----------------------
+
+CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
+Robbie Ferguson
+
+No Copyright
+
+The person who associated a work with this deed has dedicated the work to
+the public domain by waiving all of his or her rights to the work worldwide
+under copyright law, including all related and neighboring rights, to the extent
+allowed by law.
+
+You can copy, modify, distribute and perform the work, even for commercial
+purposes, all without asking permission. See Other Information below.
+
+Other Information:
+
+In no way are the patent or trademark rights of any person affected by CC0,
+nor are the rights that other persons may have in the work or in how the work
+is used, such as publicity or privacy rights.
+
+Unless expressly stated otherwise, the person who associated a work with this
+deed makes no warranties about the work, and disclaims liability for all uses
+of the work, to the fullest extent permitted by applicable law.
+
+When using or citing the work, you should not imply endorsement by the
+author or the affirmer.
+
+For more details:
+https://creativecommons.org/publicdomain/zero/1.0/
+
+Authors
+-------
+
+See `AUTHORS.md`.

README.md

@@ -1,10 +1,23 @@
 # Teleport Request
 
 [![LuaCheck status](https://github.com/minetest-mods/teleport-request/workflows/luacheck/badge.svg)](https://github.com/minetest-mods/teleport-request/actions)
-[![License](https://img.shields.io/badge/license-LGPLv2.1%2B-blue.svg)](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html)
 [![ContentDB](https://content.minetest.net/packages/Traxie21/tpr/shields/downloads/)](https://content.minetest.net/packages/Traxie21/tpr/)
 
-Allows players to request from another player to be teleported to them.
+Allows players to send a request to other players to teleport to them. Includes many more teleporting features.
+
+## Installation
+
+- Unzip the archive, rename the folder to `tpr` 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
 
@@ -84,45 +97,6 @@ These are the following commands available in-game:
 - **Description:** Deny a user's request to teleport to you or teleport you to them.
 - **Required privileges:** `interact, tp`
 
-## Optional dependencies
-
-- [areas](https://github.com/minetest-mods/areas)
-- [beerchat](https://github.com/minetest-beerchat/beerchat)
-- [chat2](https://github.com/minetest-mods/chat2)
-- [gamehub](https://github.com/shivajiva101/minetest-gamehub)
-
-## Requirements
-
-This mod requires MT 5.0.0+ to run.\
-Older versions not supported.
-
-## Issues, suggestions, features & bugfixes
-
-Report bugs or suggest ideas by [creating an issue](https://github.com/ChaosWormz/teleport-request/issues/new).\
-If you know how to fix an issue, or want something to be added, consider opening a [pull request](https://github.com/ChaosWormz/teleport-request/compare).
-
-## License
-
-Copyright (C) 2014-2023 ChaosWormz and contributors.
-
-Teleport Request code is licensed under LGPLv2.1+, see [`LICENSE.md`](LICENSE.md).\
-[`tpr_warp.ogg`](sounds/tpr_warp.ogg) is licensed under [CC BY-SA 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/).
-
-## Contributors
-
-List of contributors (in no particular order):
-
-- [RobbieF](https://minetest.tv) | [GitHub](https://github.com/Cat5TV)
-- [DonBatman](https://github.com/donbatman)
-- [NathanS21](http://nathansalapat.com/) | [GitHub](https://github.com/NathanSalapat)
-- [ChaosWormz](https://github.com/ChaosWormz)
-- [Panquesito7](https://github.com/Panquesito7)
-- [coil0](https://github.com/coil0)
-- [Zeno-](https://github.com/Zeno-)
-- [indriApollo](https://github.com/indriApollo)
-- [Billy-S](https://github.com/Billy-S)
-- Traxie21, the original creator of this mod (however, he/she does not have a GitHub account anymore).
-
 ## Configuring the mod
 
 Open your `minetest.conf` located in your Minetest directory.\
@@ -140,20 +114,6 @@ Those values are the default values of the mod.\
 You can also go to your Minetest, Settings tab, All settings, Mods, and you'll find `tpr` there.\
 Or another way to do it, is changing the values in `settingtypes.txt`.
 
-## Installation
-
-- Unzip the archive, rename the folder to `tpr` 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>
-
 ## TODO
 
 - Add limitations to /tpc which only allow a user to teleport X number of blocks. Prevents users from teleporting to the edge of the world.
@@ -161,4 +121,8 @@ For further information or help, see:\
 - Rewrite to place all chat commands into one single command much like how /teleport works.
 - Make evade respect land: no teleporting inside land, but instead make sure player is standing on surface or in water.
 
-If you think something else should be added to this list, [submit an issue](https://github.com/ChaosWormz/teleport-request/issues/new).
+If you think something else should be added to this list, [submit an issue](https://github.com/minetest-mods/teleport-request/issues/new).
+
+## License
+
+See [`LICENSE.txt`](LICENSE.txt) for full license information and [`AUTHORS.md`](AUTHORS.md) for all the contributors.

commands.lua

@@ -1,6 +1,6 @@
 --[[
 Commands
-Copyright (C) 2014-2023 ChaosWormz and contributors
+Copyright (C) 2014-2024 ChaosWormz and contributors
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public

config.lua

@@ -1,6 +1,6 @@
 --[[
 Configuration
-Copyright (C) 2014-2023 ChaosWormz and contributors
+Copyright (C) 2014-2024 ChaosWormz and contributors
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public

functions.lua

@@ -1,6 +1,6 @@
 --[[
 Functions
-Copyright (C) 2014-2023 ChaosWormz and contributors
+Copyright (C) 2014-2024 ChaosWormz and contributors
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public

init.lua

@@ -1,6 +1,8 @@
 --[[
-Allows players to request from another player to be teleported to them, and do much more.
-Copyright (C) 2014-2023 ChaosWormz and contributors
+Allows players to request from another player to be teleported to them.
+Includes many more teleporting features. Built for Minetest.
+
+Copyright (C) 2014-2024 ChaosWormz and contributors
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
@@ -19,11 +21,8 @@ USA
 
 ----------------------------------------------------------------------------
 
-Originally made by Traxie21 and released with the WTFPL license.
-Forum link: https://forum.minetest.net/viewtopic.php?id=4457
-
-Updates by Zeno, Panquesito7 and ChaosWormz.
-License: LGPLv2.1+ for code, CC BY-SA 4.0 for sounds.
+Originally made by Traxie21 and released under the WTFPL license.
+Forum link: https://forum.minetest.net/viewtopic.php?t=4457
 --]]
 
 local MP = minetest.get_modpath(minetest.get_current_modname())
@@ -69,5 +68,5 @@ dofile(MP .. "/commands.lua")
 
 -- Log
 if minetest.settings:get_bool("log_mods") then
-	minetest.log("action", S("[Teleport Request] TPS Teleport v@1 Loaded!", tp.version))
+	minetest.log("action", "[MOD] Teleport Request v" .. tp.version .. " loaded!")
 end

locale/template.txt

@@ -53,4 +53,3 @@ Teleporting to @1.=
 There is no place by that name. Keep in mind this is case-sensitive.=
 Accept teleport/area requests from another player=
 Deny teleport/area requests from another player=
-[Teleport Request] TPS Teleport v@1 Loaded!=

locale/tpr.es.tr

@@ -52,5 +52,4 @@ Usage: /tpp <place>=Uso: /tpp <lugar>
 Teleporting to @1.=Teletransportandose a @1.
 There is no place by that name. Keep in mind this is case-sensitive.=No hay lugar con ese nombre. Tenga en cuenta que esto es caso-sensitivo.
 Accept teleport/area requests from another player=Aceptar solicitudes de otro jugador
-Deny teleport/area requests from another player=Denegar solicitudos de otro jugador
-[Teleport Request] TPS Teleport v@1 Loaded!=[Teleport Request] Solicitud de teletransporte v@1 Cargado!
+Deny teleport/area requests from another player=Denegar solicitudes de otro jugador

locale/tpr.pt_BR.tr

@@ -47,4 +47,3 @@ Teleport to relative position=Teleporte para a posicao relativa
 Evade Enemy=Iludir o Inimigo
 Accept teleport requests from another player=Aceitar pedidos de teleporte de outro jogador
 Deny teleport requests from another player=Negar pedidos de teleporte de outro jogador
-[Teleport Request] TPS Teleport v@1 Loaded!=[Solicitacao de Teleporte] Teletransporte TPS v@1 Carregado!

mod.conf

@@ -1,6 +1,6 @@
 name = tpr
+title = Teleport Request
 optional_depends = areas, beerchat, chat2, gamehub
-description = Allows players to send a request to other players to teleport to them, and do much more.
+description = Allows players to send a request to other players to teleport to them. Includes many more teleporting features.
 min_minetest_version = 5.0.0
-license = LGPLv2.1
 forum = https://forum.minetest.net/viewtopic.php?t=4457

privileges.lua

@@ -1,6 +1,6 @@
 --[[
-Configuration
-Copyright (C) 2014-2023 ChaosWormz and contributors
+Privileges
+Copyright (C) 2014-2024 ChaosWormz and contributors
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public

sounds/LICENSE.txt

@@ -1,20 +0,0 @@
-Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)
-Copyright (C) 2020 David Leal (halfpacho@gmail.com) & ChaosWormz
-
-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.
-
-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.
-
-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:
-https://creativecommons.org/licenses/by-sa/4.0/