Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add plugin development chapter to book #848

Merged

Conversation

TrialDragon
Copy link
Member

This PR intends to add a chapter on developing third party plugins to the book to make the info on this topic easily findable.

Closes #298

Changed the order so that it starts with the basic stuff you need when
creating your plugin, goes into tips for when developing, then
finally the stuff you want when releasing your plugin.
Made it more conversational in tone and obvious that this targets third
party plugins.
@TrialDragon TrialDragon marked this pull request as ready for review January 7, 2024 01:14
TrialDragon and others added 2 commits January 6, 2024 18:20
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
@alice-i-cecile alice-i-cecile added S-Ready-For-Final-Review Ready for a maintainer to consider for merging A-Book C-Content labels Jan 7, 2024
Comment on lines +62 to +64
- Disable Bevy features that you don't use:
- Features are additive => Bevy features enabled in your plugin cannot be disabled by someone using your plugin
- You can find Bevy's features [here](https://github.com/bevyengine/bevy/blob/main/docs/cargo_features.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should explicitly mention the usage ofdefault-features = false on the bevy dependency, as this could easily be forgotten.

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jan 7, 2024
github-merge-queue bot pushed a commit to bevyengine/bevy that referenced this pull request Jan 7, 2024
# Objective

- Describe the objective or issue this PR addresses.
- If you're fixing a specific issue, say "Fixes #X".

Removes the old third party plugin guidelines section and related links
since it is being moved to the Bevy book in the site per
bevyengine/bevy-website#848 and
bevyengine/bevy-website#298

## Solution

- Describe the solution used to achieve the objective above. 

Removes the old links and files.
Merged via the queue into bevyengine:main with commit d41b564 Jan 7, 2024
6 checks passed
@TrialDragon TrialDragon deleted the 298_add_plugin_development_chapter branch January 8, 2024 02:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Book C-Content S-Ready-For-Final-Review Ready for a maintainer to consider for merging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add chapter on plugin development
4 participants