Initial commit

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2021 Jordan Irwin (AntumDeluge)
+
+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.

README.md

@@ -0,0 +1,24 @@
+## Personal Bookmarks
+
+### Description:
+
+A [Minetest][] mod that allows players to create a limited number of personal bookmarks to where they can teleport.
+
+***WARNING:** this mod is in early development & not ready for live use*
+
+### Licensing:
+
+- [MIT](LICENSE.txt)
+
+### Usage:
+
+### Requirements:
+
+### Links:
+
+- [Git repo](https://github.com/AntumMT/mod-pbmarks)
+- [Changelog](changelog.txt)
+- [TODO](TODO.txt)
+
+
+[Minetest]: http://minetest.net/

TODO.txt

@@ -0,0 +1,2 @@
+
+TODO:

changelog.txt

@@ -0,0 +1,4 @@
+
+v1.0
+----
+- initial release

docs/config.ld

@@ -0,0 +1,7 @@
+project = "pbmarks"
+title = "Personal Bookmarks"
+format = "markdown"
+not_luadoc = true
+boilerplate = false
+
+file = "api.lua"

docs/gendoc.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+DOCS="$(dirname $(readlink -f $0))"
+ROOT="$(dirname ${DOCS})"
+CONFIG="${DOCS}/config.ld"
+
+cd "${ROOT}"
+
+# Clean old files
+rm -rf "${DOCS}/api.html" "${DOCS}/scripts" "${DOCS}/modules" "${DOCS}/source"
+# Create new files
+ldoc -c "${CONFIG}" -d "${DOCS}" -o "api" "${ROOT}"

init.lua

@@ -0,0 +1,18 @@
+
+pbmarks = {}
+pbmarks.modname = core.get_current_modname()
+pbmarsk.modpath = core.get_modpath(pbmarks.modname)
+
+function pbmarks.log(lvl, msg)
+	if not msg then
+		msg = lvl
+		lvl = nil
+	end
+
+	msg = "[" .. pbmarks.modname .. "] " .. msg
+	if not lvl then
+		core.log(msg)
+	else
+		core.log(lvl, msg)
+	end
+end

mod.conf

@@ -0,0 +1,6 @@
+name = pbmarks
+title = Personal Bookmarks
+description = Allows players to create a limited number of personal bookmarks to where they can teleport.
+version = 1.0
+license = MIT
+author = Jordan Irwin (AntumDeluge)