diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 9be9c55..0000000 --- a/docs/index.html +++ /dev/null @@ -1,68 +0,0 @@ - - - - - leef filesystem - - - - -
- -
- -
-
-
- - -
- - - - - - -
- - -

implements essential tools for locating and reading files

- -

Modules

- - - - - - - - - -
binaryread and write (little endian) binary.
pathsmod utilities -find the paths - find mod information
- -
-
-
-generated by LDoc 1.5.0 -Last updated 2024-01-08 19:32:24 -
-
- - diff --git a/docs/ldoc.css b/docs/ldoc.css deleted file mode 100644 index f945ae7..0000000 --- a/docs/ldoc.css +++ /dev/null @@ -1,304 +0,0 @@ -/* BEGIN RESET - -Copyright (c) 2010, Yahoo! Inc. All rights reserved. -Code licensed under the BSD License: -http://developer.yahoo.com/yui/license.html -version: 2.8.2r1 -*/ -html { - color: #000; - background: #FFF; -} -body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td { - margin: 0; - padding: 0; -} -table { - border-collapse: collapse; - border-spacing: 0; -} -fieldset,img { - border: 0; -} -address,caption,cite,code,dfn,em,strong,th,var,optgroup { - font-style: inherit; - font-weight: inherit; -} -del,ins { - text-decoration: none; -} -li { - margin-left: 20px; -} -caption,th { - text-align: left; -} -h1,h2,h3,h4,h5,h6 { - font-size: 100%; - font-weight: bold; -} -q:before,q:after { - content: ''; -} -abbr,acronym { - border: 0; - font-variant: normal; -} -sup { - vertical-align: baseline; -} -sub { - vertical-align: baseline; -} -legend { - color: #000; -} -input,button,textarea,select,optgroup,option { - font-family: inherit; - font-size: inherit; - font-style: inherit; - font-weight: inherit; -} -input,button,textarea,select {*font-size:100%; -} -/* END RESET */ - -body { - margin-left: 1em; - margin-right: 1em; - font-family: arial, helvetica, geneva, sans-serif; - background-color: #ffffff; margin: 0px; -} - -code, tt { font-family: monospace; font-size: 1.1em; } -span.parameter { font-family:monospace; } -span.parameter:after { content:":"; } -span.types:before { content:"("; } -span.types:after { content:")"; } -.type { font-weight: bold; font-style:italic } - -body, p, td, th { font-size: .95em; line-height: 1.2em;} - -p, ul { margin: 10px 0 0 0px;} - -strong { font-weight: bold;} - -em { font-style: italic;} - -h1 { - font-size: 1.5em; - margin: 20px 0 20px 0; -} -h2, h3, h4 { margin: 15px 0 10px 0; } -h2 { font-size: 1.25em; } -h3 { font-size: 1.15em; } -h4 { font-size: 1.06em; } - -a:link { font-weight: bold; color: #004080; text-decoration: none; } -a:visited { font-weight: bold; color: #006699; text-decoration: none; } -a:link:hover { text-decoration: underline; } - -hr { - color:#cccccc; - background: #00007f; - height: 1px; -} - -blockquote { margin-left: 3em; } - -ul { list-style-type: disc; } - -p.name { - font-family: "Andale Mono", monospace; - padding-top: 1em; -} - -pre { - background-color: rgb(245, 245, 245); - border: 1px solid #C0C0C0; /* silver */ - padding: 10px; - margin: 10px 0 10px 0; - overflow: auto; - font-family: "Andale Mono", monospace; -} - -pre.example { - font-size: .85em; -} - -table.index { border: 1px #00007f; } -table.index td { text-align: left; vertical-align: top; } - -#container { - margin-left: 1em; - margin-right: 1em; - background-color: #f0f0f0; -} - -#product { - text-align: center; - border-bottom: 1px solid #cccccc; - background-color: #ffffff; -} - -#product big { - font-size: 2em; -} - -#main { - background-color: #f0f0f0; - border-left: 2px solid #cccccc; -} - -#navigation { - float: left; - width: 14em; - vertical-align: top; - background-color: #f0f0f0; - overflow: visible; -} - -#navigation h2 { - background-color:#e7e7e7; - font-size:1.1em; - color:#000000; - text-align: left; - padding:0.2em; - border-top:1px solid #dddddd; - border-bottom:1px solid #dddddd; -} - -#navigation ul -{ - font-size:1em; - list-style-type: none; - margin: 1px 1px 10px 1px; -} - -#navigation li { - text-indent: -1em; - display: block; - margin: 3px 0px 0px 22px; -} - -#navigation li li a { - margin: 0px 3px 0px -1em; -} - -#content { - margin-left: 14em; - padding: 1em; - width: 700px; - border-left: 2px solid #cccccc; - border-right: 2px solid #cccccc; - background-color: #ffffff; -} - -#about { - clear: both; - padding: 5px; - border-top: 2px solid #cccccc; - background-color: #ffffff; -} - -@media print { - body { - font: 12pt "Times New Roman", "TimeNR", Times, serif; - } - a { font-weight: bold; color: #004080; text-decoration: underline; } - - #main { - background-color: #ffffff; - border-left: 0px; - } - - #container { - margin-left: 2%; - margin-right: 2%; - background-color: #ffffff; - } - - #content { - padding: 1em; - background-color: #ffffff; - } - - #navigation { - display: none; - } - pre.example { - font-family: "Andale Mono", monospace; - font-size: 10pt; - page-break-inside: avoid; - } -} - -table.module_list { - border-width: 1px; - border-style: solid; - border-color: #cccccc; - border-collapse: collapse; -} -table.module_list td { - border-width: 1px; - padding: 3px; - border-style: solid; - border-color: #cccccc; -} -table.module_list td.name { background-color: #f0f0f0; min-width: 200px; } -table.module_list td.summary { width: 100%; } - - -table.function_list { - border-width: 1px; - border-style: solid; - border-color: #cccccc; - border-collapse: collapse; -} -table.function_list td { - border-width: 1px; - padding: 3px; - border-style: solid; - border-color: #cccccc; -} -table.function_list td.name { background-color: #f0f0f0; min-width: 200px; } -table.function_list td.summary { width: 100%; } - -ul.nowrap { - overflow:auto; - white-space:nowrap; -} - -dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;} -dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;} -dl.table h3, dl.function h3 {font-size: .95em;} - -/* stop sublists from having initial vertical space */ -ul ul { margin-top: 0px; } -ol ul { margin-top: 0px; } -ol ol { margin-top: 0px; } -ul ol { margin-top: 0px; } - -/* make the target distinct; helps when we're navigating to a function */ -a:target + * { - background-color: #FF9; -} - - -/* styles for prettification of source */ -pre .comment { color: #558817; } -pre .constant { color: #a8660d; } -pre .escape { color: #844631; } -pre .keyword { color: #aa5050; font-weight: bold; } -pre .library { color: #0e7c6b; } -pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; } -pre .string { color: #8080ff; } -pre .number { color: #f8660d; } -pre .function-name { color: #60447f; } -pre .operator { color: #2239a8; font-weight: bold; } -pre .preprocessor, pre .prepro { color: #a33243; } -pre .global { color: #800080; } -pre .user-keyword { color: #800080; } -pre .prompt { color: #558817; } -pre .url { color: #272fc2; text-decoration: underline; } - diff --git a/docs/modules/binary.html b/docs/modules/binary.html deleted file mode 100644 index f68fe46..0000000 --- a/docs/modules/binary.html +++ /dev/null @@ -1,284 +0,0 @@ - - - - - leef filesystem - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module binary

-

read and write (little endian) binary.

-

located in leef.binary.

- - -

reading binary inputs

- - - - - - - - - - - - - - - - - -
read_single (function)read an IEEE 754 single precision (32-bit) floating point number
read_double (function)read an IEEE 754 double-precision (64-bit) floating point number
read_uint (function, int)read an unsigned integer of any given length
read_uint (function, int)read a signed integer of any given length
-

misc binary helpers

- - - - - -
fround (number)"returns nearest 32-bit single precision float representation of a number" (or something)
-

expected function inputs

- - - - - - - - - -
read_byte ()read_byte is a param name which refers to a function which reads the next byte- returning a whole number between 0-255.
write_byte ()write_byte is similar to read_byte, however it is given an input and expected to write it to the file.
- -
-
- - -

reading binary inputs

- -
- read a binary inputs using a read_byte function. -
-
-
- - read_single (function) -
-
- read an IEEE 754 single precision (32-bit) floating point number - - -

Parameters:

- - - - - - -
-
- - read_double (function) -
-
- read an IEEE 754 double-precision (64-bit) floating point number - - -

Parameters:

- - - - - - -
-
- - read_uint (function, int) -
-
- read an unsigned integer of any given length - - -

Parameters:

-
    -
  • function - read_byte -
  • -
  • int - length in bytes of unsigned integer -
  • -
- - - - - -
-
- - read_uint (function, int) -
-
- read a signed integer of any given length - - -

Parameters:

-
    -
  • function - read_byte -
  • -
  • int - length in bytes of integer -
  • -
- - - - - -
-
-

misc binary helpers

- -
-
- - fround (number) -
-
- "returns nearest 32-bit single precision float representation of a number" (or something) - - -

Parameters:

-
    -
  • number - - - -
  • -
- -

Returns:

-
    - - nearest 32-bit single precision float representation of a number -
- - - - -
-
-

expected function inputs

- -
- functions will expect either a read_byte or write_byte function as inputs -
-
-
- - read_byte () -
-
- -

read_byte is a param name which refers to a function which reads the next byte- returning a whole number between 0-255.

- -
function byte()
-    left = left - 1
-    return assert(file_handle:read(1):byte())
-    --reads the next chracter, and converts it to a "numerical code" using string.byte()
-    --it's important that this function moves forward in the file stream (as :read(1) does)
-end
-
- - - - -

Returns:

-
    - - a bytecode (an int between 0 and 255.) -
- - - - -
-
- - write_byte () -
-
- write_byte is similar to read_byte, however it is given an input and expected to write it to the file. - (example needed) - - - - - - - -
-
- - -
-
-
-generated by LDoc 1.5.0 -Last updated 2024-01-08 19:32:24 -
-
- - diff --git a/docs/modules/paths.html b/docs/modules/paths.html deleted file mode 100644 index 1958335..0000000 --- a/docs/modules/paths.html +++ /dev/null @@ -1,185 +0,0 @@ - - - - - leef filesystem - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module paths

-

mod utilities -find the paths - find mod information

-

- -

- - -

Tables

- - - - - - - - - - - - - - - - - -
media_pathspaths of loaded media.
modname_by_mediamodname by media.
overriden_media_pathsoverriden media paths.
overriden_media_pathsmods with overriden media (indexed by media).
- -
-
- - -

Tables

- -
-
- - media_paths -
-
- paths of loaded media. - a list of filepaths of loaded media, i.e:

-
{
-    ["model.b3d"] = "C:/path/minetest/mods/mod2/models/model.b3d"
-    ["img.png"] = "C:/path/minetest/mods/mod2/textures/img.png"
-}
-
-

NOTE: "loaded" meaning the final mediapath- what the client loads. - - - - - - - -

-
- - modname_by_media -
-
- -

modname by media. - a list of mods by indexed by the name of loaded media

-
{
-    ["model.b3d"] = "mod2"
-}
-
- - - - - - - - -
-
- - overriden_media_paths -
-
- -

overriden media paths. - a list of media paths that were overriden by conflicting model names- the unloaded media, i.e:

-
{
-    ["model.b3d"] = {
-        "C:/path/minetest/mods/mod1/models/model.b3d"
-    }
-}
-
- - - - - - - - -
-
- - overriden_media_paths -
-
- -

mods with overriden media (indexed by media). - a list of mods that have overriden media, by media names

-
{
-    ["model.b3d"] = {
-        "mod1",
-    }
-}
-
- - - - - - - - -
-
- - -
-
-
-generated by LDoc 1.5.0 -Last updated 2024-01-08 19:32:24 -
-
- - diff --git a/ldoc/config.ld b/ldoc/config.ld deleted file mode 100644 index 2d7b0f8..0000000 --- a/ldoc/config.ld +++ /dev/null @@ -1,9 +0,0 @@ -project="leef filesystem" -title="leef filesystem" -description="implements essential tools for locating and reading files" -format="markdown" -backtick_references=false -file = { - "../", -} -dir='../docs' diff --git a/ldoc/ldoc manual.url b/ldoc/ldoc manual.url deleted file mode 100644 index 063cadc..0000000 --- a/ldoc/ldoc manual.url +++ /dev/null @@ -1,6 +0,0 @@ -[{000214A0-0000-0000-C000-000000000046}] -Prop3=19,11 -[InternetShortcut] -IDList= -URL=https://stevedonovan.github.io/ldoc/manual/doc.md.html -HotKey=0 diff --git a/ldoc/windows_quick_generate.bat b/ldoc/windows_quick_generate.bat deleted file mode 100644 index a025533..0000000 --- a/ldoc/windows_quick_generate.bat +++ /dev/null @@ -1,3 +0,0 @@ -# literally just so I dont have to open powershell every time. -@echo off -ldoc . \ No newline at end of file