-
Notifications
You must be signed in to change notification settings - Fork 518
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b58bbb5
commit 2ed4fd5
Showing
1 changed file
with
58 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,70 @@ | ||
| # The Blot | ||
| # Blot, the plotter bot from Hack Club | ||
|
|
||
| > blot is a plotting bot from Hack Club | ||
| **[💻 Online Editor: Make art](https://blot.hackclub.dev/editor)** | **[👀 Gallery](https://blot.hackclub.dev/gallery)** | **[🕸 Landing Page](https://blot.hackclub.dev)** | ||
|
|
||
| This is the next "you ship, we ship"[^1] project. This time, if you make some digital art, we'll send you the parts to build a drawing robot which can make that art real! | ||
| Create programmatic art in our web-based editor and submit it to the gallery and we'll send you a CNC machine which can make that art. | ||
| Blot is a "You Ship, We Ship" project from [Hack Club](https://hackclub.com) (like [Sprig](https://github.com/hackclub/sprig)). | ||
|
|
||
| [^1]: Like [Sprig](https://sprig.hackclub.com)—where you ship a project, and Hack Club ships you hardware/electronics. | ||
|  | ||
|
|
||
|  | ||
| A piece of art made for Blot can be the first program you ever write, but it can also be a challenge for a master programmer. Check out some of the art made already in our gallery. | ||
|
|
||
| # Info | ||
| [](https://blot.hackclub.dev/gallery) | ||
|
|
||
| The editor can be found [here](https://blot.hackclub.dev/). | ||
| # Blot is... | ||
|
|
||
| The virtual maze is here. | ||
| **A custom CNC drawing machine** designed from scratch to introduce you to digital fabrication. It's made of 6 unique 3D printed parts with a custom control board and easy to understand firmware, which can be interfaced with through JavaScript in the browser. | ||
|
|
||
| # Getting Involved | ||
| <img width="499" alt="parts" src="https://github.com/hackclub/blot/assets/27078897/04ab7345-03fa-4b60-9870-64a99327e8cd"> | ||
|
|
||
| We post regular updates in our [CHANGELOG](./CHANGELOG.md). | ||
|  | ||
|
|
||
| We have a [TODO](./TODO.md) list which you can check out for various tasks that are being worked on (or need to be worked on). | ||
| Check out the 3D model of the project here (COMING SOON). | ||
|
|
||
| One of the best ways to get involved is by building and testing one of the machines. All you need is a 3D printer and a little bit of hardware outlined in the [bill of materials](./drawing-thing-v2). | ||
| You can find the 3D parts for the model here (LINK PARTS LIST). | ||
|
|
||
| If you're a teen who wants to follow along with the project you can join the Hack Club Slack and head to the [#blot](https://app.slack.com/client/T0266FRGM/C04GCH8A91D) channel. | ||
| **A web based editor for programmatic art** that we designed specifically for pen plotting with a custom geometry library. | ||
|
|
||
| <img width="1353" alt="editor" src="https://github.com/hackclub/blot/assets/27078897/6f444dcf-cd44-4e49-986a-3bd9b57e6593"> | ||
|
|
||
| # To get started | ||
|
|
||
| Check out the examples in the [gallery](https://blot.hackclub.dev/gallery) and then follow along with some of our [guides](https://blot.hackclub.dev/guides). | ||
|
|
||
| The guides are designed to work like visual coding puzzles, which incrementally bring you through building generative art pieces. | ||
|
|
||
| # It's all Open Source | ||
|
|
||
| Every part of Blot is freely available for you to investigate and discover. | ||
| That includes the editor, the hardware design, the electronics, and even the finances around the project. | ||
|
|
||
| # Development | ||
|
|
||
| Join the `#blot` channel on the [Hack Club Slack](https://hackclub.com/slack). | ||
|
|
||
| The Blot editor is made with astro. To run the project locally. | ||
|
|
||
| You'll need: | ||
|
|
||
| ``` | ||
| Git | ||
| Node.js | ||
| Yarn | ||
| ``` | ||
|
|
||
| After installing those, clone the repo. | ||
|
|
||
| ``` | ||
| git clone https://github.com/hackclub/blot/ | ||
| cd blot/astro | ||
| yarn install | ||
| ``` | ||
|
|
||
| To run the development server. | ||
|
|
||
| ``` | ||
| yarn dev | ||
| ``` | ||
|
|
||
| # License | ||
| The Hack Club Blot is open source and licensed under the [MIT License](https://github.com/hackclub/blot/LICENSE.md). Fork, remix, and make it your own! Pull requests and other contributions greatly appreciated. |
2ed4fd5There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
blot – ./astro
blot.hackclub.dev
blot-git-main.hackclub.dev