Skip to content

Commit

Permalink
docs: update on the vsc extension and roadmap
Browse files Browse the repository at this point in the history
  • Loading branch information
gudzpoz committed Apr 12, 2024
1 parent 42e20e4 commit a2555c3
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,9 @@ By leveraging the simple syntax of **Markdown** and the power of **Lua**, Brocat

2. I want to use Brocatel in my own project.

A [VS Code](https://code.visualstudio.com/) extension is on the way to facilitate development and debugging. Before then, if you want to use Brocatel in real games, you might need to use a bit of CLI, i.e., clone this project and `pnpm install && pnpm build`. You will need to use the compiler under the `mdc/` directory and bundle the runtime under the `vm/` directory with your game. Documentation is coming soon.
A [Brocatel VS Code extension](https://marketplace.visualstudio.com/items?itemName=gudzpoz.vscode-brocatel) extension has been published both to the VS Marketplace and the Open VSX Registry. You may use it to aid your story writing by getting syntax error highlights and instant previews.

The extension will probably support compiling, debugging and exporting Brocatel stories very soon. Before then, if you want to use Brocatel in real games, you will need to use a bit of CLI, i.e., use `npx --package @brocatel/mdc@0.3.5 -- brocatelc YOUR_MARKDOWN_FILE.md` to compile your files, which should generate a `.lua` file (the story) and a `.pot` file (for translators). To actually get the story out of the `.lua` file, you will need to use the [`brocatel`](https://luarocks.org/modules/gudzpoz/brocatel) Lua library, whose API is available at [https://gudzpoz.github.io/brocatel/api/](https://gudzpoz.github.io/brocatel/api/).

<details><summary>Navigation</summary>

Expand Down
1 change: 1 addition & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export default defineConfig({
{
text: 'Getting Started',
items: [
{ text: 'Introduction', link: '/intro' },
{ text: 'The Tutorial', link: '/tutorial' },
{ text: 'Cloak of Darkness', link: '/cloak' },
],
Expand Down
5 changes: 5 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<md-example :markdown="text" :height="'60vh'">

<<< ../README.md

</md-example>
2 changes: 2 additions & 0 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ Markdown compiler implementation:

- [ ] Save & load.
- [X] API.
- [ ] Examples? Or detailed Lua documentation.
- [ ] Fast-forward (skipping only texts that users have read).
- [ ] Instead, we should probably export read counts along with the lines
to let the user / the outer game engine decide whether to skip lines
Expand All @@ -89,6 +90,7 @@ Multi-thread (not *those* threads) support:
- [X] Tail call support: jump to elsewhere, popping up a stack frame.
- [ ] Compiler error: forbid jumping from inside of a function.
- [ ] Coroutine support.
- What about structured concurrency?

Some clarifications:
- With **threads**, you may build games (with *lots* of tweaks, of course) like
Expand Down

0 comments on commit a2555c3

Please sign in to comment.