<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - fork/livesplit-core @ master</title>
<meta name="description" content="README.md in fork/livesplit-core at master.">
<meta property="og:title" content="README.md - fork/livesplit-core @ master">
<meta property="og:description" content="README.md in fork/livesplit-core at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="d8564b6a104c9f865b55a8fab2559b3fe571934e">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/livesplit-core</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/livesplit-core</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Christopher Serr</span><span class="commit-message" data-commit="0c0b62e42d5ff7a5c9e95e030115315d9e125797">Use cargo's new `--crate-type` parameter (#565)</span><span class="snapshot-sha sha" data-commit="0c0b62e42d5ff7a5c9e95e030115315d9e125797">0c0b62e</span><time datetime="2022-09-22T19:08:59+02:00" title="2022-09-22 19:08:59 +0200">2022-09-22</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/livesplit-core/ref/master/">master</a><strong>tags</strong><a href="/fork/livesplit-core/ref/v0.10.0/">v0.10.0</a><a href="/fork/livesplit-core/ref/v0.11.0/">v0.11.0</a><a href="/fork/livesplit-core/ref/v0.5.1/">v0.5.1</a><a href="/fork/livesplit-core/ref/v0.6.0/">v0.6.0</a><a href="/fork/livesplit-core/ref/v0.7.0/">v0.7.0</a><a href="/fork/livesplit-core/ref/v0.8.0/">v0.8.0</a><a href="/fork/livesplit-core/ref/v0.8.1/">v0.8.1</a><a href="/fork/livesplit-core/ref/v0.9.0/">v0.9.0</a><a class="all" href="/fork/livesplit-core/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/livesplit-core/">livesplit-core</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>3.1 KiB</span><span>83 lines</span></span><span class="actions"><a class="raw" href="/fork/livesplit-core/raw/cb08ba57f526419c162a2a1629933c911a86982b/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>&lt;img src="https://raw.githubusercontent.com/LiveSplit/LiveSplit/master/LiveSplit/Resources/Icon.png" alt="LiveSplit" height="42" width="45" align="top"/&gt; livesplit-core</h1>
<p><a href="https://github.com/LiveSplit/livesplit-core/actions"><img src="https://github.com/LiveSplit/livesplit-core/workflows/Build/badge.svg" alt="Build Status" /></a>
<a href="https://crates.io/crates/livesplit-core"><img src="https://img.shields.io/crates/v/livesplit-core.svg" alt="crates.io" /></a>
<a href="https://www.npmjs.com/package/livesplit-core"><img src="https://img.shields.io/npm/v/livesplit-core.svg" alt="npm" /></a>
<a href="https://docs.rs/livesplit-core/"><img src="https://docs.rs/livesplit-core/badge.svg" alt="docs.rs" /></a>
<a href="https://deps.rs/repo/github/LiveSplit/livesplit-core"><img src="https://deps.rs/repo/github/LiveSplit/livesplit-core/status.svg" alt="dependency status" /></a></p>
<p>livesplit-core is a library that provides a lot of functionality for creating a
speedrun timer. It can be used directly from Rust. Additional bindings are
available for the following programming languages:</p>
<ul>
<li>C</li>
<li>C++</li>
<li>C#</li>
<li>Java with Java Native Access or Java Native Interface</li>
<li>Kotlin with Java Native Interface</li>
<li>Swift</li>
<li>Ruby</li>
<li>Python</li>
<li>JavaScript + TypeScript for Node.js and WebAssembly</li>
</ul>
<p>The documentation is available here:</p>
<ul>
<li><a href="https://docs.rs/livesplit-core/">Rust Documentation</a></li>
<li><a href="https://livesplit.org/livesplit-core-docs/">TypeScript Documentation</a></li>
</ul>
<h2>Projects using <code>livesplit-core</code></h2>
<ul>
<li><a href="https://github.com/LiveSplit/LiveSplitOne">LiveSplit One Web</a></li>
<li><a href="https://github.com/CryZe/livesplit-one-desktop">LiveSplit One Desktop Prototype</a></li>
<li><a href="https://github.com/CryZe/obs-livesplit-one">LiveSplit One OBS Plugin</a></li>
<li><a href="https://github.com/DarkRTA/chronos">chronos Terminal Timer</a></li>
<li><a href="https://github.com/dagit/annelid">annelid</a></li>
<li><a href="https://splits.io">splits.io (Parsing)</a></li>
</ul>
<h2>Build Instructions</h2>
<p>You can install Rust with the installer available on <a href="https://rustup.rs/">rustup.rs</a>.
Clone the repository and build the library with the following command:</p>
<pre class="language-bash"><a-f>cargo</a-f> build <a-co>--release</a-co> <a-co>-p</a-co> livesplit-core-capi</pre>
<p>The library will then be available as a shared and static library in the
<code>target</code> folder. If you only want to build the library as a shared or static
library, not both, you can run either one of the following commands:</p>
<pre class="language-bash"><a-c># Shared Library</a-c>
<a-f>cargo</a-f> rustc <a-co>--release</a-co> <a-co>-p</a-co> livesplit-core-capi <a-co>--crate-type</a-co> cdylib
<a-c># Static Library</a-c>
<a-f>cargo</a-f> rustc <a-co>--release</a-co> <a-co>-p</a-co> capi <a-co>--crate-type</a-co> staticlib</pre>
<p>If you want to build the bindings for the library too, you need to go into the
<code>capi/bind_gen</code> folder and run the following command:</p>
<pre class="language-bash"><a-f>cargo</a-f> run</pre>
<p>The bindings will then be available in <code>capi/bindings</code>.</p>
<h2>Download</h2>
<p>Builds for a lot of common platforms are available in the <a href="https://github.com/LiveSplit/livesplit-core/releases">Releases</a>.</p>
<h2>License</h2>
<p>Licensed under either of</p>
<ul>
<li>Apache License, Version 2.0 (<a href="/fork/livesplit-core/ref/master/blob/LICENSE-APACHE">LICENSE-APACHE</a> or
http://www.apache.org/licenses/LICENSE-2.0)</li>
<li>MIT license (<a href="/fork/livesplit-core/ref/master/blob/LICENSE-MIT">LICENSE-MIT</a> or http://opensource.org/licenses/MIT)
at your option.</li>
</ul>
<h3>Contribution</h3>
<p>Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you shall be dual licensed as above, without any
additional terms or conditions.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>&lt;img src=&quot;https://raw.githubusercontent.com/LiveSplit/LiveSplit/master/LiveSplit/Resources/Icon.png&quot; alt=&quot;LiveSplit&quot; height=&quot;42&quot; width=&quot;45&quot; align=&quot;top&quot;/&gt; livesplit-core</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">[![Build Status](https://github.com/LiveSplit/livesplit-core/workflows/Build/badge.svg)](https://github.com/LiveSplit/livesplit-core/actions)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">[![crates.io](https://img.shields.io/crates/v/livesplit-core.svg)](https://crates.io/crates/livesplit-core)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">[![npm](https://img.shields.io/npm/v/livesplit-core.svg)](https://www.npmjs.com/package/livesplit-core)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">[![docs.rs](https://docs.rs/livesplit-core/badge.svg)](https://docs.rs/livesplit-core/)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">[![dependency status](https://deps.rs/repo/github/LiveSplit/livesplit-core/status.svg)](https://deps.rs/repo/github/LiveSplit/livesplit-core)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">livesplit-core is a library that provides a lot of functionality for creating a</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">speedrun timer. It can be used directly from Rust. Additional bindings are</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">available for the following programming languages:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>- </a-p>C</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>- </a-p>C++</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>- </a-p>C#</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>- </a-p>Java with Java Native Access or Java Native Interface</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>- </a-p>Kotlin with Java Native Interface</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>- </a-p>Swift</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>- </a-p>Ruby</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>- </a-p>Python</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>- </a-p>JavaScript + TypeScript for Node.js and WebAssembly</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>The documentation is available here:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>- [Rust Documentation](https://docs.rs/livesplit-core/)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>- [TypeScript Documentation](https://livesplit.org/livesplit-core-docs/)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>## </a-p><a-tt>Projects using `livesplit-core`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>- [LiveSplit One Web](https://github.com/LiveSplit/LiveSplitOne)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>- [LiveSplit One Desktop Prototype](https://github.com/CryZe/livesplit-one-desktop)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>- [LiveSplit One OBS Plugin](https://github.com/CryZe/obs-livesplit-one)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>- [chronos Terminal Timer](https://github.com/DarkRTA/chronos)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>- [annelid](https://github.com/dagit/annelid)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>- [splits.io (Parsing)](https://splits.io)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>## </a-p><a-tt>Build Instructions</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>You can install Rust with the installer available on [rustup.rs](https://rustup.rs/).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>Clone the repository and build the library with the following command:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>cargo build </a-p><a-co>--release</a-co><a-p> </a-p><a-co>-p</a-co><a-p> livesplit-core-capi</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>The library will then be available as a shared and static library in the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>`target` folder. If you only want to build the library as a shared or static</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>library, not both, you can run either one of the following commands:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p># Shared Library</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>cargo rustc </a-p><a-co>--release</a-co><a-p> </a-p><a-co>-p</a-co><a-p> livesplit-core-capi </a-p><a-co>--crate-type</a-co><a-p> cdylib</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p># Static Library</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>cargo rustc </a-p><a-co>--release</a-co><a-p> </a-p><a-co>-p</a-co><a-p> capi </a-p><a-co>--crate-type</a-co><a-p> staticlib</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>If you want to build the bindings for the library too, you need to go into the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>`capi/bind_gen` folder and run the following command:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>cargo run</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>The bindings will then be available in `capi/bindings`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>## </a-p><a-tt>Download</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>Builds for a lot of common platforms are available in the [Releases](https://github.com/LiveSplit/livesplit-core/releases).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>## </a-p><a-tt>License</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>Licensed under either of</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>  http://www.apache.org/licenses/LICENSE-2.0)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>  at your option.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>### </a-p><a-tt>Contribution</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text">Unless you explicitly state otherwise, any contribution intentionally submitted</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text">for inclusion in the work by you shall be dual licensed as above, without any</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text">additional terms or conditions.</span></span></pre></div></div>
</main>
</body>
</html>
