<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>NibblePoker's LuaJIT Sleep Library</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>LuaJIT-Sleep</h1>
<h2>Contents</h2>
<ul>
<li><a href="#Features">Features </a></li>
<li><a href="#Requirements">Requirements </a></li>
<li><a href="#Installation">Installation </a></li>
<li><a href="#Example">Example </a></li>
<li><a href="#License">License </a></li>
</ul>
<h2>Topics</h2>
<ul class="">
<li><strong>readme</strong></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../index.html">sleep</a></li>
</ul>
</div>
<div id="content">
<h1>LuaJIT - Sleep</h1>
<p>Pure LuaJIT bindings and wrappers for native sleep functions on Win32 and Linux.</p>
<blockquote>
<p><strong>📢 This is library is in low maintenance mode</strong> \
I consider it feature-complete, and unless a bug is found, I don't plan on updating it.</p>
</blockquote>
<p><a name="Features"></a></p>
<h2>Features</h2>
<p>* Second-level sleeps
* Millisecond-level sleeps
* Ability to supress all errors</p>
<p><a name="Requirements"></a></p>
<h2>Requirements</h2>
<p>* A somewhat modern OS</p>
<pre>
* Windows XP <span class="keyword">or</span> newer *(x86/x64) (Untested on ARM32/ARM64)*
* Windows Server <span class="number">2003</span> <span class="keyword">or</span> newer *(x86/x64) (Untested on ARM32/ARM64)*
* Linux <span class="number">4.4</span>+ *(x86/x64) (Untested on ARM32/ARM64/RISCV/...)*
</pre>
<p>* <em>LuaJIT v2.1.</em></p>
<p><a name="Installation"></a></p>
<h2>Installation</h2>
<h3>Manual</h3>
<p>1. Download the <a href="https://github.com/aziascreations/LuaJIT-Sleep/releases">latest release</a>.
2. Extract the content of the archive in your <code>lua/</code> folder.</p>
<h3>LuaRocks</h3>
<p>* TODO: Will be done soon-ish</p>
<p><a name="Example"></a></p>
<h2>Example</h2>
<pre>
<span class="keyword">local</span> sleep_lib = <span class="global">require</span>(<span class="string">"sleep"</span>)
<span class="global">print</span>(<span class="string">"Now sleeping for 3 seconds..."</span>)
sleep_lib.<span class="function-name">sleep_s</span>(<span class="number">3</span>)
<span class="global">print</span>(<span class="string">"Now sleeping for 500 milliseconds..."</span>)
sleep_lib.<span class="function-name">sleep_ms</span>(<span class="number">500</span>)
<span class="global">print</span>(<span class="string">"I'm back and awake"</span>)
</pre>
<p><a name="License"></a></p>
<h2>License</h2>
<p>The code in this repository is licensed under
<a href="LICENSE">CC0 1.0 Universal (CC0 1.0) (Public Domain)</a>.</p>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2026-04-12 07:30:52 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
aziascreations