Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
demonnic committed Nov 3, 2020
1 parent 2bdb301 commit 9886397
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,23 @@ These files contain the modules in the MDK. You only need to include those files
You should also include demontools.lua, as it notes below several other of the MDK modules make use of items within it.

* demontools.lua
* Collection of miscellaneous useful functions. You should include this file if you use the MDK, as several other modules make use of it
* Collection of miscellaneous useful functions. You should include this file if you use the MDK, as several other modules make use of it. Include functions for converting c/d/hecho, html, and ansi colored strings between each other, mkdir_p, and some others. Documented at the API docs linked above.

* chyron.lua
* Label which moves a message across its face from right to left, like a stock ticker or the news chyrons. Documentation at https://github.com/demonnic/MDK/wiki/Chyron

* EMCO.lua
* EMCO. Documentation at https://github.com/demonnic/EMCO/wiki
* EMCO. Documentation at https://github.com/demonnic/EMCO/wiki Will make use of LoggingConsole if loggingconsole.lua and demontools.lua are included

* gradientmaker.lua
* Functions for creating color gradients for use with c/d/hecho. Documentation at https://github.com/demonnic/MDK/wiki/gradientmaker

* ftext.lua
* basic fText. Documentation at https://github.com/demonnic/fText/wiki

* loggingconsole.lua
* Self logging extension to the mini console. Works just like a Geyser.MiniConsole but adds a templated path and fileName constraint, as well as logFormat so it can log what is echod or appended to it. Requires demontools.lua in order to work.

* sortbox.lua
* SortBox, an alternative to H/VBox which can be either, and also provides options for sorting its contents. Overview at https://github.com/demonnic/MDK/wiki/SortBox

Expand Down
2 changes: 1 addition & 1 deletion src/resources/mdkversion.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.0.11
1.1.0
2 changes: 1 addition & 1 deletion src/scripts/MDKExample/Example.lua
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
MDKExample = MDKExample or { version = "1.0.11" }
MDKExample = MDKExample or { version = "1.1.0" }
function MDKExample.exampleFText()
local fText = require("@PKGNAME@.ftext")
cecho(fText.fText("Testing!", {width = 40, formatType = 'c', textColor = '<orange>', capColor = '<purple>', cap = '[TEST]'}))
Expand Down

0 comments on commit 9886397

Please sign in to comment.