Skip to content

Commit 15e1f63

Browse files
committed
some corrections to the latest screecast
1 parent 0b862d0 commit 15e1f63

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

content/tutorials/developing-a-rust-plugin.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ This tutorial will walk you through developing a Zellij plugin with rust, using
2323
- [Step 2: Receiving user input](#step-2-receiving-user-input)
2424
- [Step 3: Parsing and reacting to the Zellij state](#step-3-parsing-and-reacting-to-the-zellij-state)
2525
- [Step 4: Finalizing and distributing the plugin](#step-4-finalizing-and-distributing-the-plugin)
26+
- [Documentation, API-references and getting Help](#documentation-api-references-and-getting-help)
2627
- [Do you like Zellij?](#do-you-like-zellij--)
2728

2829
## What are we building?
@@ -331,7 +332,7 @@ But what if we'd like to react to keys the user pressed while to react to keys t
331332
Our generated plugin template includes a `pipe` method, which will be triggered every time messages are piped to our plugin:
332333

333334
```rust
334-
impl ZellijPlugin {
335+
impl ZellijPlugin for State {
335336
// ...
336337
fn pipe (&mut self, pipe_message: PipeMessage) -> bool {
337338
let mut should_render = false;
@@ -345,7 +346,7 @@ Right now, this method doesn't do much. Similar to the `update` method described
345346
Let's add some debug printing to see how this works:
346347

347348
```rust
348-
impl ZellijPlugin {
349+
impl ZellijPlugin for State {
349350
// ...
350351
fn pipe (&mut self, pipe_message: PipeMessage) -> bool {
351352
let mut should_render = false;
@@ -679,6 +680,15 @@ Be sure to change the plugin name in the linked file from `carousel` to your plu
679680

680681
If you create a plugin and would like to share it with the community, you can also make a PR to [awesome-zellij](https://github.com/zellij-org/awesome-zellij).
681682

683+
## Documentation, API-references and getting help
684+
For further reading, you can check out the full plugin development documentation: https://zellij.dev/documentation/plugins
685+
686+
For the Rust API reference, check out: https://docs.rs/zellij-tile/latest/zellij_tile/index.html
687+
688+
The latter includes a list of [commands](https://docs.rs/zellij-tile/latest/zellij_tile/shim/index.html) that plugins can issue to Zellij. As well as a list of [`Event`s](https://docs.rs/zellij-tile/latest/zellij_tile/prelude/enum.Event.html) plugins can subscribe to.
689+
690+
If you would like help, please join our [Discord](https://discord.gg/CrUAFH3) - many plugin developers hang out there.
691+
682692
## Do you like Zellij ❤️ ?
683693
Me too! So much so that I spend 100% of my time developing and maintaining it and have no other income.
684694

0 commit comments

Comments
 (0)