diff --git a/README.md b/README.md index 0861587..6f923c9 100644 --- a/README.md +++ b/README.md @@ -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/).
Navigation diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index a4571d3..826a69a 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -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' }, ], diff --git a/docs/intro.md b/docs/intro.md new file mode 100644 index 0000000..58c890f --- /dev/null +++ b/docs/intro.md @@ -0,0 +1,5 @@ + + +<<< ../README.md + + diff --git a/docs/roadmap.md b/docs/roadmap.md index c651e0b..389b0e9 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -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 @@ -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