Skip to content

Commit

Permalink
Deploying to gh-pages from @ dfd0160 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@gudzpoz
gudzpoz committed Apr 13, 2024
0 parents commit e433c6d
Show file tree
Hide file tree
Showing 84 changed files with 8,550 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
22 changes: 22 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>404 | Brocatel</title>
<meta name="description" content="Not Found">
<meta name="generator" content="VitePress v1.1.0">
<link rel="preload stylesheet" href="/brocatel/assets/style.I3J3TBpI.css" as="style">

<script type="module" src="/brocatel/assets/app.Dqb5Aue9.js"></script>
<link rel="preload" href="/brocatel/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="icon" href="/brocatel/favicon.png">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-b8a0c3bb><!--[--><!--]--><!--[--><span tabindex="-1" data-v-7c25d53e></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-7c25d53e> Skip to content </a><!--]--><!----><header class="VPNav" data-v-b8a0c3bb data-v-1cf4043b><div class="VPNavBar top" data-v-1cf4043b data-v-4649d3e9><div class="wrapper" data-v-4649d3e9><div class="container" data-v-4649d3e9><div class="title" data-v-4649d3e9><div class="VPNavBarTitle" data-v-4649d3e9 data-v-6625836f><a class="title" href="/brocatel/" data-v-6625836f><!--[--><!--]--><!--[--><img class="VPImage logo" src="/brocatel/favicon.svg" alt data-v-a58f79b2><!--]--><span data-v-6625836f>Brocatel</span><!--[--><!--]--></a></div></div><div class="content" data-v-4649d3e9><div class="content-body" data-v-4649d3e9><!--[--><!--]--><div class="VPNavBarSearch search" data-v-4649d3e9><!----></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-4649d3e9 data-v-72512b88><span id="main-nav-aria-label" class="visually-hidden" data-v-72512b88>Main Navigation</span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/brocatel/" tabindex="0" data-v-72512b88 data-v-0ab65143><!--[--><span data-v-0ab65143>Home</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/brocatel/api/index.html" tabindex="0" data-v-72512b88 data-v-0ab65143><!--[--><span data-v-0ab65143>Lua API</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-4649d3e9 data-v-06d82b4c><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-06d82b4c data-v-178e0bf3 data-v-4a3e9267><span class="check" data-v-4a3e9267><span class="icon" data-v-4a3e9267><!--[--><span class="vpi-sun sun" data-v-178e0bf3></span><span class="vpi-moon moon" data-v-178e0bf3></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-4649d3e9 data-v-f8a5db70 data-v-8bfd9852><!--[--><a class="VPSocialLink no-icon" href="https://github.com/gudzpoz/brocatel" aria-label="github" target="_blank" rel="noopener" data-v-8bfd9852 data-v-692b82e8><span class="vpi-social-github" /></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-4649d3e9 data-v-2426c6f4 data-v-3336626f><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-3336626f><span class="vpi-more-horizontal icon" data-v-3336626f></span></button><div class="menu" data-v-3336626f><div class="VPMenu" data-v-3336626f data-v-d97c4361><!----><!--[--><!--[--><!----><div class="group" data-v-2426c6f4><div class="item appearance" data-v-2426c6f4><p class="label" data-v-2426c6f4>Appearance</p><div class="appearance-action" data-v-2426c6f4><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-2426c6f4 data-v-178e0bf3 data-v-4a3e9267><span class="check" data-v-4a3e9267><span class="icon" data-v-4a3e9267><!--[--><span class="vpi-sun sun" data-v-178e0bf3></span><span class="vpi-moon moon" data-v-178e0bf3></span><!--]--></span></span></button></div></div></div><div class="group" data-v-2426c6f4><div class="item social-links" data-v-2426c6f4><div class="VPSocialLinks social-links-list" data-v-2426c6f4 data-v-8bfd9852><!--[--><a class="VPSocialLink no-icon" href="https://github.com/gudzpoz/brocatel" aria-label="github" target="_blank" rel="noopener" data-v-8bfd9852 data-v-692b82e8><span class="vpi-social-github" /></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-4649d3e9 data-v-059166de><span class="container" data-v-059166de><span class="top" data-v-059166de></span><span class="middle" data-v-059166de></span><span class="bottom" data-v-059166de></span></span></button></div></div></div></div><div class="divider" data-v-4649d3e9><div class="divider-line" data-v-4649d3e9></div></div></div><!----></header><div class="VPLocalNav empty fixed" data-v-b8a0c3bb data-v-91ec9230><div class="container" data-v-91ec9230><!----><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-91ec9230 data-v-54739266><button data-v-54739266>Return to top</button><!----></div></div></div><!----><div class="VPContent" id="VPContent" data-v-b8a0c3bb data-v-8ad92198><!--[--><div class="NotFound" data-v-8ad92198 data-v-06b92e68><p class="code" data-v-06b92e68>404</p><h1 class="title" data-v-06b92e68>PAGE NOT FOUND</h1><div class="divider" data-v-06b92e68></div><blockquote class="quote" data-v-06b92e68>But if you don&#39;t change your direction, and if you keep looking, you may end up where you are heading.</blockquote><div class="action" data-v-06b92e68><a class="link" href="/brocatel/" aria-label="go to home" data-v-06b92e68>Take me home</a></div></div><!--]--></div><!----><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"caveat.md\":\"BZcbNl_r\",\"choices.md\":\"CyM2Rem7\",\"grammar.md\":\"BMmGD0XR\",\"roadmap.md\":\"CSPz4nvH\",\"playground.md\":\"DegUY1Fb\",\"subroutine.md\":\"CEkEELLe\",\"arch.md\":\"zRQd76DL\",\"tutorial.md\":\"CJBU2V63\",\"index.md\":\"6XjIfR9O\",\"intro.md\":\"CxHVxIcA\",\"cloak.md\":\"ntPeYRwv\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Brocatel\",\"description\":\"Write your game plots in Markdown and Lua.\",\"base\":\"/brocatel/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/favicon.svg\",\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Lua API\",\"link\":\"/api/index.html\"}],\"sidebar\":[{\"text\":\"Getting Started\",\"items\":[{\"text\":\"Introduction\",\"link\":\"/intro\"},{\"text\":\"The Tutorial\",\"link\":\"/tutorial\"},{\"text\":\"Cloak of Darkness\",\"link\":\"/cloak\"}]},{\"text\":\"Advanced Usages\",\"items\":[{\"text\":\"Advanced Choices\",\"link\":\"/choices\"},{\"text\":\"Story Subroutines\",\"link\":\"/subroutine\"},{\"text\":\"Caveats\",\"link\":\"/caveat\"},{\"text\":\"Complete Grammar\",\"link\":\"/grammar\"}]},{\"text\":\"Internals\",\"items\":[{\"text\":\"Architecture\",\"link\":\"/arch\"},{\"text\":\"Road Map\",\"link\":\"/roadmap\"}]},{\"text\":\"Playground\",\"link\":\"/playground\"}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/gudzpoz/brocatel\"}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>

</body>
</html>
4 changes: 4 additions & 0 deletions api/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 1dcb6560dc23c77328097e711d2d55da
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added api/.doctrees/api.doctree
Binary file not shown.
Binary file added api/.doctrees/environment.pickle
Binary file not shown.
Binary file added api/.doctrees/index.doctree
Binary file not shown.
28 changes: 28 additions & 0 deletions api/_sources/api.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
API references
==============

The ``brocatel`` module
-----------------------

.. lua:automodule:: brocatel
The ``VM`` class
----------------

.. lua:autoclass:: brocatel.VM
The ``Output`` type
-------------------

.. lua:autoclass:: Output
.. lua:autoclass:: Selectable
.. lua:autoclass:: Text
The ``TablePath`` class
-----------------------

.. lua:alias:: TablePathSeg = string|number
.. lua:autoclass:: TablePath
43 changes: 43 additions & 0 deletions api/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Welcome to brocatelVM's documentation!
======================================

.. toctree::
:maxdepth: 2

api

What is it?
===========

Brocatel VM is a Lua library that runs the story Lua files
generated by `the Brocatel compiler <https://github.com/gudzpoz/brocatel>`_.

Usage
=====

An example
----------

.. code:: lua
local brocatel = require("brocatel")
local content = io.open("file_compiled_by_brocatel.lua", "r"):read("*a")
local vm = brocatel.load_vm(content)
local option = nil
while true do
local line = vm:next(option)
if line == nil then
break
elseif line.text then
print(line.text)
elseif line.select then
option = get_user_input(line.select)
end
end
Indices and tables
==================

* :ref:`genindex`
* :ref:`lua-modindex`
* :ref:`search`
Loading

0 comments on commit e433c6d

Please sign in to comment.