https://github.com/drbap/laser-beam-for-obsidian

Laser beam plugin for Obsidian. Laser reading lines for live preview, source and reading modes.
https://github.com/drbap/laser-beam-for-obsidian

laser-reading-line obsidian-plugin reading-laser

Last synced: 3 days ago
JSON representation

Laser beam plugin for Obsidian. Laser reading lines for live preview, source and reading modes.

• Host: GitHub
• URL: https://github.com/drbap/laser-beam-for-obsidian
• Owner: drbap
• License: mit
• Created: 2024-05-08T02:03:31.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-06-09T18:56:13.000Z (10 months ago)
• Last Synced: 2025-03-26T06:11:22.476Z (20 days ago)
• Topics: laser-reading-line, obsidian-plugin, reading-laser
• Language: TypeScript
• Homepage:
• Size: 3.78 MB
• Stars: 11
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• jimsghstars - drbap/laser-beam-for-obsidian - Laser beam plugin for Obsidian. Laser reading lines for live preview, source and reading modes. (TypeScript)

README

        
# Laser beam plugin for Obsidian

![Laser beam plugin](images/laser_beam_plugin_intro.png)

**Laser beam** is a plugin for Obsidian.md designed to enhance your reading experience by utilizing customizable laser lines.  These lines are virtual guides meant to improve reading focus and concentration.

## Overview and Features

![Laser beam plugin](images/laser_beam_01.png)

> Default theme - laser line (blue)

- **Customizable Laser Lines**: You can choose between 2 laser focus types, **laser line** or **laser area**, to personalize your reading experience and find what works best for you.

![Laser beam plugin](images/laser_beam_02.png)

> Default theme - laser area (green)

- **Improved Focus**: The laser lines guide your eyes across the page, line by line, minimizing distractions and keeping you on track. This can be particularly helpful for people who struggle with maintaining focus while reading.

- **Colors**: blue, green, orange, yellow, red, pink, purple (7 colors).

![Laser beam plugin](images/laser_beam_04.png)

- **Themes**: It is designed to work on any theme. Click the Laser ribbon icon to turn the laser line on or off.

![Laser beam plugin](images/laser_beam_03.png)

> MagicUser theme

## Laser preferences

![Laser beam plugin](images/laser_beam_settings.png)

## Functionality

**Desktop version**:

- The laser lines will **follow the mouse cursor** (**dynamic** status - default).

- You can select **static** status to have a fixed laser position.

- The laser lines will **follow the text cursor** (**caret**).

**Mobile devices**: Touch the screen to select the desired laser line location.

## Command Palette

- You can activate/deactivate the laser line using the **Command Palette** or by setting a keyboard **shortcut**. You can also toggle between laser line and laser area (focus type).

I hope this plugin helps to improve your reading focus and performance (daily study and work tasks).

> This plugin is an improved version of the reading laser of **MagicUser theme** for Obsidian.

## Installation

1. Open **Obsidian Settings**.

2. In the side menu, select **Community plugins**.

3. Select **Browse** (button).

4. Search for **Laser beam**.

5. Select it and choose **Install**.

6. **Enable** Laser beam after installation.

## Manually installing the plugin

- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/laser-beam/`.

## Feedback

Have suggestions for new features, usability improvements, or found a bug? Your feedback is appreciated! Submit an issue on GitHub and I'll do my best to respond as soon as possible. Thanks.

## License and Acknowledgements

Laser beam plugin for Obsidian

MIT License ⓒ Bernardo Pires

The laser beam (ribbon icon) is from [Lucide](https://lucide.dev/) Icons used by Obsidian. The Lucide icon library is licensed under the [ISC License](https://lucide.dev/license).