sammyette/Hilbish
2
2
Fork 0
mirror of https://github.com/Hilbis/Hilbish synced 2025-07-01 16:52:03 +00:00
Code Issues Releases Wiki Activity

deploy: 5f171b9ef2055e49f0937ea2d6c3cdd3ce2396ac

Browse Source
This commit is contained in:
sammy-ette 2025-06-15 20:23:48 +00:00
parent 312c2db503
commit 809cdb24f9
3 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
versions/yarn/docs/api/index.xml
View File

@ -9,6 +9,6 @@ Parameters This function has no parameters.
Types Snail A Snail is a shell script interpreter instance.
Methods dir(path) Changes the directory of the snail instance.</description></item><item><title>Module terminal</title><link>https://rosettea.github.io/Hilbish/versions/yarn/docs/api/terminal/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/yarn/docs/api/terminal/</guid><description>Introduction The terminal library is a simple and lower level library for certain terminal interactions.
Functions restoreState() Restores the last saved state of the terminal saveState() Saves the current state of the terminal. setRaw() Puts the terminal into raw mode. size() Gets the dimensions of the terminal. Returns a table with width and height terminal.restoreState() Restores the last saved state of the terminal
Parameters This function has no parameters.</description></item><item><title>Module yarn</title><link>https://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/</guid><description> Introduction Yarn is a simple multithreading library. Threads are individual Lua states, so they do NOT share the same environment as the code that runs the thread. Bait and Commanders are shared though, so you can throw hooks from 1 thread to another.
Parameters This function has no parameters.</description></item><item><title>Module yarn</title><link>https://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/</guid><description>Introduction Yarn is a simple multithreading library. Threads are individual Lua states, so they do NOT share the same environment as the code that runs the thread. Bait and Commanders are shared though, so you can throw hooks from 1 thread to another.
Example:
1local yarn = require &amp;#39;yarn&amp;#39; 2 3-- calling t will run the yarn thread. 4local t = yarn.thread(print) 5t &amp;#39;printing from another lua state!&amp;#39; Types Thread Methods</description></item></channel></rss>
1local yarn = require &amp;#39;yarn&amp;#39; 2 3-- calling t will run the yarn thread. 4local t = yarn.thread(print) 5t &amp;#39;printing from another lua state!&amp;#39; Functions thread(fun) -&amp;gt; @Thread Creates a new, fresh Yarn thread.</description></item></channel></rss>

5
versions/yarn/docs/api/yarn/index.html
View File

@ -9,7 +9,10 @@ Bait and Commanders are shared though, so you <em>can</em> throw hooks from 1 th
</span></span><span class=line><span class=ln>3</span><span class=cl><span class=c1>-- calling t will run the yarn thread.</span>
</span></span><span class=line><span class=ln>4</span><span class=cl><span class=kd>local</span> <span class=n>t</span> <span class=o>=</span> <span class=n>yarn.thread</span><span class=p>(</span><span class=n>print</span><span class=p>)</span>
</span></span><span class=line><span class=ln>5</span><span class=cl><span class=n>t</span> <span class=s1>&#39;printing from another lua state!&#39;</span>
</span></span></code></pre></div><h3 id=types class=heading>Types
</span></span></code></pre></div><h3 id=functions class=heading>Functions
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#thread>thread(fun) -> @Thread</a></td><td>Creates a new, fresh Yarn thread.</td></tr></tbody></table><hr><div id=thread><h4 class=heading>yarn.thread(fun) -> <a href=/Hilbish/docs/api/yarn/#thread style=text-decoration:none id=lol>Thread</a>
<a href=#thread class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Creates a new, fresh Yarn thread.<br><code>fun</code> is the function that will run in the thread.</p><h5 id=parameters class=heading>Parameters
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><h3 id=types class=heading>Types
<a href=#types class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><h3 id=thread class=heading>Thread
<a href=#thread class=heading-link><i class="fas fa-paperclip"></i></a></h3><h4 id=methods class=heading>Methods
<a href=#methods class=heading-link><i class="fas fa-paperclip"></i></a></h4></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea &copy; 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>

4
versions/yarn/index.xml
View File

@ -71,9 +71,9 @@ Parameters This function has no parameters.
Types Snail A Snail is a shell script interpreter instance.
Methods dir(path) Changes the directory of the snail instance.</description></item><item><title>Module terminal</title><link>https://rosettea.github.io/Hilbish/versions/yarn/docs/api/terminal/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/yarn/docs/api/terminal/</guid><description>Introduction The terminal library is a simple and lower level library for certain terminal interactions.
Functions restoreState() Restores the last saved state of the terminal saveState() Saves the current state of the terminal. setRaw() Puts the terminal into raw mode. size() Gets the dimensions of the terminal. Returns a table with width and height terminal.restoreState() Restores the last saved state of the terminal
Parameters This function has no parameters.</description></item><item><title>Module yarn</title><link>https://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/</guid><description> Introduction Yarn is a simple multithreading library. Threads are individual Lua states, so they do NOT share the same environment as the code that runs the thread. Bait and Commanders are shared though, so you can throw hooks from 1 thread to another.
Parameters This function has no parameters.</description></item><item><title>Module yarn</title><link>https://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/</guid><description>Introduction Yarn is a simple multithreading library. Threads are individual Lua states, so they do NOT share the same environment as the code that runs the thread. Bait and Commanders are shared though, so you can throw hooks from 1 thread to another.
Example:
1local yarn = require &amp;#39;yarn&amp;#39; 2 3-- calling t will run the yarn thread. 4local t = yarn.thread(print) 5t &amp;#39;printing from another lua state!&amp;#39; Types Thread Methods</description></item><item><title>Notification</title><link>https://rosettea.github.io/Hilbish/versions/yarn/docs/features/notifications/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/yarn/docs/features/notifications/</guid><description>Hilbish features a simple notification system which can be used by other plugins and parts of the shell to notify the user of various actions. This is used via the hilbish.message interface.
1local yarn = require &amp;#39;yarn&amp;#39; 2 3-- calling t will run the yarn thread. 4local t = yarn.thread(print) 5t &amp;#39;printing from another lua state!&amp;#39; Functions thread(fun) -&amp;gt; @Thread Creates a new, fresh Yarn thread.</description></item><item><title>Notification</title><link>https://rosettea.github.io/Hilbish/versions/yarn/docs/features/notifications/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/yarn/docs/features/notifications/</guid><description>Hilbish features a simple notification system which can be used by other plugins and parts of the shell to notify the user of various actions. This is used via the hilbish.message interface.
A message is defined as a table with the following properties:
icon: A unicode/emoji icon for the notification. title: The title of the message text: Message text/body channel: The source of the message. This should be a unique and easily readable text identifier.</description></item><item><title>Options</title><link>https://rosettea.github.io/Hilbish/versions/yarn/docs/features/opts/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/yarn/docs/features/opts/</guid><description>Opts are simple toggle or value options a user can set in Hilbish. As toggles, there are things like autocd or history saving. As values, there is the motd which the user can either change to a custom string or disable.
Opts are accessed from the hilbish.opts table. Here they can either be read or modified