Lively

A Ruby framework for building interactive web applications for creative coding.

Usage

Please see the project documentation for more details.

• Getting Started - This guide will help you get started with Lively, a framework for building real-time applications in Ruby.

• Building a Worms Game with Lively - This tutorial will guide you through creating a Worms-style game using Lively, a Ruby framework for building real-time applications.

• Building a Flappy Bird Game with Live Views - This tutorial will guide you through creating a complete Flappy Bird-style game using Live Views, a Ruby framework for building real-time interactive applications.

• Game Audio Tutorial - This guide shows you how to add audio to your Live.js games and applications using the live-audio library. You'll learn how to play sound effects, background music, and create dynamic audio experiences.

Releases

Please see the project releases for all releases.

v0.17.0

• Expose shared application state via Application[..., controller: Controller.new].

v0.16.2

• Modernize internals and update dependencies.

v0.16.1

• Updated game audio tutorial content.

v0.16.0

• Updated live-audio component dependencies.

v0.15.1

• Fixed handling of spaces in asset names.

v0.15.0

• Added platformer-style game example.
• Improved game audio tutorial.

v0.14.1

• Added bake tasks for release management.

v0.14.0

• Fixed guide rendering and test suite.

v0.13.1

• Tidied up gem dependencies.

v0.13.0

• Added live-audio support for background and positional audio in applications.
• Added game audio example demonstrating audio playback.
• Fixed serving non-existent asset paths gracefully.
• Achieved 100% test and documentation coverage.

See Also

• live — Provides client-server communication using websockets.
• mayu — A live streaming server-side component-based VirtualDOM rendering framework.

Contributing

We welcome contributions to this project.

1. Fork it.
2. Create your feature branch (git checkout -b my-new-feature).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin my-new-feature).
5. Create new Pull Request.

Running Tests

To run the test suite:

bundle exec sus

Making Releases

To make a new release:

bundle exec bake gem:release:patch # or minor or major

Developer Certificate of Origin

In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.

Community Guidelines

This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.