simple-sketch

Simple Sketch

Overview

Simple Sketch is a plugin for Obsidian. It allows users to create simple sketches in a dedicated view with a minimal, convenient interface that emphasizes productivity over completeness.

Installation

For Contributors

1. Fork the repository on GitHub.

2. Clone your forked repository in your obsidian plugins folder:

   git clone [email protected]:your-username/obsidian-simple-sketch.git
   cd simple-sketch-plugin
   

3. Install the dependencies:

   npm install
   

4. Build the project:

   npm run build
   

5. Run the project:

   npm run dev
   

For Users

1. recommended: install from the community plugins browser in the application settings.

or

1. download the main.js and manifest.json from the last release

2. copy them in a simple-sketch folder in your local plugins folder

Usage

1. Open Obsidian and navigate to the settings.
2. Go to the "Community plugins" section and enable the "Simple Sketch" plugin.
3. Once enabled, you will see a new ribbon icon with a pencil and ruler.
4. Click on the ribbon icon to open the Simple Sketch view
   or
   Right-click on an image file and select open with simple sketch
5. In the Simple Sketch view, you can:
   • Draw freehand sketches.
   • Generate shapes like lines, rectangles, and ellipses.
   • Add text to your sketches.
   • Save your sketches in the vault or download them as images.

Enjoy creating your sketches with Simple Sketch!

Controls

Icon	Functionality	Key Binding
	Draw by hand	none
	Draw line	none
	Draw rectangle	none
	Draw filled rectangle	none
	Draw ellipse	none
	Draw filled ellipse	none
	Add text	none
	Erase	none
	Undo	ctrl + z
	Redo	ctrl + shift + z
	Toggle grid	ctrl + shift + g
	Save sketch in vault	none
	Download sketch	none
	Reset canvas	none

Icons are imported from Lucide to be consistent with the Obsidian interface.

Contribution

Contributions are welcome! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Make your changes and commit them with clear messages.
4. Push your changes to your fork.
5. Create a pull request to the main repository.

Work in progress

I am actively working on the following features and improvements:

• Enhanced Drawing Tools: Adding more shapes and tools for better sketching capabilities.
• bugfix: Fixing issues related to drawing precision and performance.

This plugin is a contribution to the Obsidian community, and I work on it in my free time. As a result, I may be slow to react if anything is asked. Thank you for your understanding and patience.

Stay tuned for updates and feel free to contribute to these features!

Issues

If you encounter any issues or have any questions, please open an issue on the GitHub repository.

Support

If you would like to support the development of this plugin, you can make a donation through Buy Me a Coffee

Thank you for your support!

License

This project is licensed under the GNU Lesser General Public License. See the LICENSE file for more details.