A wrapper script for webcam streaming on Debian based images, especially for Raspberry Pi OS Lite images like MainsailOS. Mainly written in Python.

• Why is it called crowsnest?
• Support
• Documentation
• Compatibility
• Contribute
• How to support us?
• What 'Backends' does crowsnest use
• Credits

It inherited his name from sailing ships crow's nest.

A crow's nest is a structure in the upper part of the main mast of a ship or a structure that is used as a lookout point.
See https://en.wikipedia.org/wiki/Crow's_nest

So, this will be the 'lookout point' for your printer.

Please read carefully on how to configure crowsnest to your needs! Check out the help section for first aid or join our Discord server if you need further help. For some topics that are not covered in the documentation, just read below.

PS: Do not open issues that are based on misconfiguration! The issue tracker is only there to track actual bugs in the code and feature requests.

You can find our docs at https://docs.mainsail.xyz/crowsnest/

If there is something in our documentation that is not covered, is described in a way that is misunderstood, or simply is missing, please let us know here!

To be able to use all features and streamers you need a Raspberry Pi with a Raspberry Pi OS based image with at least Python 3.10.

For other systems we recommend Debian based images, as they come with bash and the apt package manager that we rely on for installation.

Non Debian based images are not officially supported and never will be.

1. Create an Issue related to your topic.
2. Prepare a tested Pull Request against the develop branch
   • Please use commits formatted according to Conventional Commits
   • Make sure you do not ignore the code formatting as provided by the .editorconfig of this repo
3. Be patient. Every PR has to go through some sort of "internal gates" before it reaches the current default branch, unless an immediate response is crucial.

Support the mainsail project

Please consider hitting the ⭐ button in the upper right hand corner to show some love for this project.

Please see the according backends section in our documentation.

A huge thank you to KwadFan for the original bash implementation, and a huge shoutout to lixxbox and alexz from the mainsail-crew, who gave KwadFan ideas for improvements and tested the original code.
Without these guys it simply were not possible to get that done.

Thanks to Pedro Lamas, for the ISSUE_TEMPLATES.

Thanks to ayufan for helping with the original camera-streamer implementation.

So, with all that said, get your position seaman! Prepare to get wet feets on your journey.