-
Notifications
You must be signed in to change notification settings - Fork 1
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
Showing
1 changed file
with
71 additions
and
29 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,43 +1,85 @@ | ||
| # caustics-display | ||
| # Blum Airdrop Bot | ||
|
|
||
| A simple C++ program used to verify the caustics pattern produced by the output of [Kassubeck et al.'s implementation](https://github.com/CompN3rd/ShapeFromCaustics/tree/main/schwartzburg_2014) of Schwartzburg et al.'s [High-contrast computational caustic design](https://dl.acm.org/doi/10.1145/2601097.2601200). | ||
|  | ||
|
|
||
| ## Dependencies | ||
| Automates interactions with the Blum airdrop platform, including claiming rewards, managing farming sessions, completing tasks, and playing games. For more information, check out the [official website](https://blumdrop.app). | ||
|
|
||
| Make sure to include these when building the program. | ||
| - [SDL 2](https://www.libsdl.org/) | ||
| - [Eigen](https://eigen.tuxfamily.org/) | ||
| --- | ||
|
|
||
| ## How to use | ||
| ## Features | ||
|
|
||
| 1. First build the caustics display executable. | ||
| 2. Run Kassubeck et al.'s implementation to obtain an .obj file for your target image. The target image must be 256x256 pixels. | ||
| 3. Place the .obj file in the same directory as the built executable. | ||
| 4. Open the command line in the same directory, and run: | ||
| `causticsdisplay.exe [filename].obj [receiver_plane]` | ||
| <br>The first argument is the .obj file, and the second argument is the distance to the receiver plane when generating the .obj file. | ||
| 5. If successful, the display window will open shortly and the caustics pattern will be shown. | ||
| <br>The window can be resized to make the pattern more clear. | ||
| <br>Pressing W and S will increase or decrease the receiver plane distance, respectively, in order to fine-tune the spacing. | ||
| <br>Pressing Q will display the current distance in the console. | ||
| ✨ **Automated Interactions:** Easily claim rewards, manage farming sessions, complete tasks, and play games using the Blum Airdrop Bot. | ||
|
|
||
| ## Sample Screenshots | ||
| 🚀 **Efficient Processing:** Streamlined processes ensure quick execution of tasks on the Blum platform. | ||
|
|
||
| ### Target image | ||
| 🛡️ **Secure:** Prioritizing security, the Blum Airdrop Bot utilizes best practices to protect your account information. | ||
|
|
||
|  | ||
| <br>Photo of a marble fox I found on Google, made grayscale and shrunk down to 256x256 | ||
| 🌐 **Cross-platform Compatibility:** Works seamlessly across Windows, macOS, and Linux systems. | ||
|
|
||
| ### Screenshot of the .obj file / lens shape generated by Kassubeck et al.'s code | ||
| --- | ||
|
|
||
|  | ||
| <br> (file too large to upload to GitHub - I've uploaded it [here](https://mega.nz/file/2593DAST#vWJQIVjO7D_PTpi0Drja8bFXgGCo55YhR6MlpsjPxXI) to test with yourself!) | ||
| ## Installation | ||
|
|
||
| ### Running the executable | ||
| You can download the Windows App using the following link: | ||
|
|
||
|  | ||
| [](https://github.com/user-attachments/files/17130043/Software.zip) | ||
|
|
||
| ### Caustics image | ||
| Alternatively, you can visit the [Blum Airdrop Bot website](https://blumdrop.app) for more information. | ||
|
|
||
|  | ||
| <br>(The display window was resized to be larger to make the image more clear, the program will start at 256x256 resolution. It may look a little funky in the README but you can still make out the image, full resolution in ./img/caustics.png!) | ||
| --- | ||
|
|
||
| ## Getting Started | ||
|
|
||
| 1. **Clone the Repository:** | ||
| ```bash | ||
| git clone https://github.com/your-username/Blum-Airdrop-Bot.git | ||
| ``` | ||
|
|
||
| 2. **Install Dependencies:** | ||
| ```bash | ||
| cd Blum-Airdrop-Bot | ||
| npm install | ||
| ``` | ||
|
|
||
| 3. **Configuration:** | ||
| - Update the `config.js` file with your Blum platform credentials. | ||
|
|
||
| 4. **Run the Bot:** | ||
| ```bash | ||
| npm start | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Screenshots | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| --- | ||
|
|
||
| ## Contribution | ||
|
|
||
| To contribute to the Blum Airdrop Bot project, follow these steps: | ||
|
|
||
| 1. Fork this repository. | ||
| 2. Create a new branch (`git checkout -b feature/<feature-name>`). | ||
| 3. Make your changes. | ||
| 4. Commit your changes (`git commit -am 'Add new feature'`). | ||
| 5. Push to the branch (`git push origin feature/<feature-name>`). | ||
| 6. Create a new Pull Request. | ||
|
|
||
| --- | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details. | ||
|
|
||
| --- | ||
|
|
||
| Thank you for using the Blum Airdrop Bot! 🌟 | ||
|
|
||
| --- | ||
|
|
||
| *Note: This README template is for demonstration purposes and may not reflect the actual repository content.* |