Plugin Development Tutorial / API Docs #5
+369
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Snowiiii
reviewed
Jan 21, 2025
Comment on lines
+10
to
+22
| pub struct MyPlugin {} | ||
|
|
||
| impl MyPlugin { | ||
| pub fn new() -> Self { | ||
| MyPlugin {} | ||
| } | ||
| } | ||
|
|
||
| impl Default for MyPlugin { | ||
| fn default() -> Self { | ||
| Self::new() | ||
| } | ||
| } |
There was a problem hiding this comment.
pub struct MyPlugin; will be enough, no need for the other implementations
There was a problem hiding this comment.
mhh i get an error when having non default, is there a way to prevent that ?
rustc: no function or associated item named `new` found for struct `MyPlugin` in the current scope
items from traits can only be used if the trait is implemented and in scope
the following traits define an item `new`, perhaps you need to implement one of them:
There was a problem hiding this comment.
The #[plugin_impl] proc macro uses the new() on the struct to construct it so that you can have your own fields in it
Snowiiii
reviewed
Jan 21, 2025
Comment on lines
+83
to
+95
| pub struct MyPlugin {} | ||
|
|
||
| impl MyPlugin { | ||
| pub fn new() -> Self { | ||
| MyPlugin {} | ||
| } | ||
| } | ||
|
|
||
| impl Default for MyPlugin { | ||
| fn default() -> Self { | ||
| Self::new() | ||
| } | ||
| } |
Snowiiii
reviewed
Jan 21, 2025
Comment on lines
+7
to
+15
| Before we can get started, we need to have a folder to house our plugin's source code. Either create one using the file explorer, or from the command line using: | ||
| ```bash | ||
| mkdir hello-pumpkin && cd hello-pumpkin | ||
| ``` | ||
|
|
||
| Next we need to initialize our crate, do so by running this command in the folder you created: | ||
| ```bash | ||
| cargo init --lib | ||
| ``` |
There was a problem hiding this comment.
I think it would simpler to replace this with cargo new <name> --lib.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to add docs and a development tutorial for the Pumpkin plugin system from Pumpkin-MC/Pumpkin#339
TODO