From 5a7f6b05f1f63a95007e1054cba58766680c2a08 Mon Sep 17 00:00:00 2001 From: ethanlchristensen Date: Sun, 10 Nov 2024 19:38:32 -0600 Subject: [PATCH] updates --- docs/source/bruheffect/index.rst | 2 - docs/source/demos/fire_demo.rst | 7 +++ docs/source/demos/index.rst | 77 +++++++++++++++++++++++++++++--- 3 files changed, 79 insertions(+), 7 deletions(-) create mode 100644 docs/source/demos/fire_demo.rst diff --git a/docs/source/bruheffect/index.rst b/docs/source/bruheffect/index.rst index 3bebd8b..5011a28 100644 --- a/docs/source/bruheffect/index.rst +++ b/docs/source/bruheffect/index.rst @@ -1,5 +1,3 @@ - - Bruheffect ========== diff --git a/docs/source/demos/fire_demo.rst b/docs/source/demos/fire_demo.rst new file mode 100644 index 0000000..99d0019 --- /dev/null +++ b/docs/source/demos/fire_demo.rst @@ -0,0 +1,7 @@ +Fire Demo +========= + +.. automodule:: bruhanimate.demos.fire_demo + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/demos/index.rst b/docs/source/demos/index.rst index 2f13a7b..e1c98e7 100644 --- a/docs/source/demos/index.rst +++ b/docs/source/demos/index.rst @@ -3,12 +3,83 @@ Demos This section contains content related to the demos package. +Overview +-------- +The `demos` package offers a diverse collection of interactive programs, each designed to illustrate different visual and auditory effects. Whether you are interested in learning, teaching, or creatively applying these demonstrations, the `demos` package provides a comprehensive array of examples to support your endeavors. + +Key Modules and Purposes: +- **audio_demo** + + Demonstrates audio processing capabilities, including playback, analysis, and manipulation of sound files to enhance multimedia projects. + +- **chatbot_demo** + + Illustrates a basic chatbot setup, showcasing natural language processing and interaction through text-based communication. + +- **fire_demo** + + Features a realistic simulation of fire, focusing on particle effects and rendering techniques to create dynamic fire visuals. + +- **firework_demo** + + Highlights the beauty of fireworks through colorful animations, demonstrating the use of particle systems and timing for dramatic effects. + +- **gol_demo** + + Simulates Conway's Game of Life, a cellular automaton, providing insights into complex patterns that emerge from simple rules. + +- **holiday** + + Offers a collection of festive effects suitable for holiday seasons, enhancing projects with themes of celebration and joy. + +- **line_demo** + + Demonstrates the creation of line-based graphics, ideal for artistic visualizations and geometric explorations. + +- **matrix_demo** + + Recreates the iconic digital rain from "The Matrix," providing a cyberpunk aesthetic through cascading symbols. + +- **noise_demo** + + Generates various noise patterns, useful for texture creation and background effects in visual designs. + +- **offset_demo** + + Explores visual displacement techniques, adding creative distortions and transitions to projects. + +- **plasma_demo** + + Displays swirling, vibrant plasma patterns, perfect for psychedelic and colorful effects. + +- **rain_demo** + + Simulates realistic falling rain, providing atmospheric effects for animations and visual environments. + +- **snow_demo** + + Adds falling snow effects to scenes, ideal for winter and holiday-themed visual projects. + +- **stars_demo** + + Renders a starry sky or cosmic scene, suitable for astronomical and space-related animations. + +- **static_demo** + + Produces a static noise effect, reminiscent of old television screens, great for retro or glitch aesthetics. + +- **twinkle_demo** + + Provides twinkling star effects, adding sparkle and dynamic interest to celestial backgrounds. + +Explore these modules to discover the impressive demonstrations available with the `demos` package, and apply them to learn, teach, or create captivating effects in your projects. + .. toctree:: :maxdepth: 2 - :caption: Demos Contents: audio_demo chatbot_demo + fire_demo firework_demo gol_demo holiday @@ -22,7 +93,3 @@ This section contains content related to the demos package. stars_demo static_demo twinkle_demo - -Overview --------- -Description of the demos modules and their purposes...