<!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 @ v0.7.0</title>
<meta name="description" content="README.md in fork/livesplit-core at v0.7.0.">
<meta property="og:title" content="README.md - fork/livesplit-core @ v0.7.0">
<meta property="og:description" content="README.md in fork/livesplit-core at v0.7.0.">
<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="v0.7.0" data-tip="72a23e0e92bcf4721e7c84d595d7ee330de54f8d">
<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="06e2f47f8b3c880b0d2114ba2835e6a12ac3eba4">Release v0.5.1</span><span class="snapshot-sha sha" data-commit="06e2f47f8b3c880b0d2114ba2835e6a12ac3eba4">06e2f47</span><time datetime="2017-05-28T01:34:30+02:00" title="2017-05-28 01:34:30 +0200">2017-05-28</time></p>
<header class="topbar"><details class="switcher"><summary>v0.7.0</summary><div class="menu"><strong>branches</strong><a 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 class="current" 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>1.8 KiB</span><span>45 lines</span></span><span class="actions"><a class="raw" href="/fork/livesplit-core/raw/8fb20c5f0b7da31f56f74f0a98e1fadb13e4c2a0/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">&lt;h1&gt; &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&lt;/h1&gt;
<p><a href="https://travis-ci.org/CryZe/livesplit-core"><img src="https://travis-ci.org/CryZe/livesplit-core.svg?branch=master" alt="Build Status" /></a>
<a href="https://ci.appveyor.com/project/CryZe/livesplit-core/branch/master"><img src="https://ci.appveyor.com/api/projects/status/bvv4un099w94kari/branch/master?svg=true" 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://docs.rs/livesplit-core/"><img src="https://docs.rs/livesplit-core/badge.svg" alt="docs.rs" /></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, asm.js and WebAssembly</li>
</ul>
<p>The Documentation for the Library is available here: <a href="https://docs.rs/livesplit-core/">API Documentation</a></p>
<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>cargo build --release -p livesplit-core-capi
</pre>
<p>The library will then be available as a shared and static library in the <code>target</code> folder.</p>
<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>cargo 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 over here: <a href="https://github.com/CryZe/livesplit-core/releases">Releases</a></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">&lt;h1&gt; &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&lt;/h1&gt;</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://travis-ci.org/CryZe/livesplit-core.svg?branch=master)](https://travis-ci.org/CryZe/livesplit-core)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">[![Build status](https://ci.appveyor.com/api/projects/status/bvv4un099w94kari/branch/master?svg=true)](https://ci.appveyor.com/project/CryZe/livesplit-core/branch/master)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</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="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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">livesplit-core is a library that provides a lot of functionality for creating a speedrun timer.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">It can be used directly from Rust.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">Additional Bindings are available for the following programming languages:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</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="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>Java with Java Native Access or Java Native Interface</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>Kotlin with 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>Swift</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>Ruby</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>Python</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>JavaScript + TypeScript for Node.js, asm.js and WebAssembly</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>The Documentation for the Library is available here: [API Documentation](https://docs.rs/livesplit-core/)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</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="L25" href="#L25">25</a><span class="code-text"></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>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="L27" href="#L27">27</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="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>```</a-p></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>cargo build --release -p livesplit-core-capi</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>```</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"></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>The library will then be available as a shared and static library in the `target` folder.</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"></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>If you want to build the Bindings for the library too, you need to go into the `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="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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</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="L39" href="#L39">39</a><span class="code-text"><a-p>```</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</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="L42" href="#L42">42</a><span class="code-text"></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>## </a-p><a-tt>Download</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text">Builds for a lot of common platforms are available over here: [Releases](https://github.com/CryZe/livesplit-core/releases)</span></span></pre></div></div>
</main>
</body>
</html>
