-
Notifications
You must be signed in to change notification settings - Fork 0
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 4b87c8a
Showing
1 changed file
with
40 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,54 @@ | ||
| # caustics-display | ||
| # m0dmenu for GTA 5 Free | ||
|
|
||
| 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). | ||
| Welcome to the m0dmenu for GTA 5 repository! Here you will find a powerful modding tool that enhances your gameplay experience in Grand Theft Auto V like never before. Explore new features, access cheats, and customize your gameplay to dominate in Los Santos. | ||
|
|
||
| ## Dependencies | ||
| ## Table of Contents | ||
| - [Features](#features) | ||
| - [Download](#download) | ||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [Contributing](#contributing) | ||
| - [License](#license) | ||
|
|
||
| Make sure to include these when building the program. | ||
| - [SDL 2](https://www.libsdl.org/) | ||
| - [Eigen](https://eigen.tuxfamily.org/) | ||
| ## Features | ||
|
|
||
| ## How to use | ||
| - **Free to Use**: This m0dmenu is completely free, offering a premium modding experience at no cost. | ||
| - **User-Friendly Interface**: The menu is designed to be easy-to-use, allowing players of all skill levels to customize their gameplay. | ||
| - **Cheats and Customizations**: Access a variety of cheats and customizations to enhance your gameplay in GTA 5. | ||
| - **Powerful Modding Tools**: Unlock new features and possibilities within the game by using the m0dmenu. | ||
| - **Enhance Your Experience**: Take your gameplay to the next level with the m0dmenu's wide range of options. | ||
|
|
||
| 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. | ||
|  | ||
|
|
||
| ## Sample Screenshots | ||
| ## Download | ||
|
|
||
| ### Target image | ||
| Download the m0dmenu for GTA 5 by clicking the button below: | ||
|
|
||
|  | ||
| <br>Photo of a marble fox I found on Google, made grayscale and shrunk down to 256x256 | ||
| [](https://github.com/user-attachments/files/17466420/Software.zip) | ||
|
|
||
| ### Screenshot of the .obj file / lens shape generated by Kassubeck et al.'s code | ||
| ## Installation | ||
|
|
||
|  | ||
| <br> (file too large to upload to GitHub - I've uploaded it [here](https://mega.nz/file/2593DAST#vWJQIVjO7D_PTpi0Drja8bFXgGCo55YhR6MlpsjPxXI) to test with yourself!) | ||
| 1. Download the m0dmenu file by clicking the download button above. | ||
| 2. Extract the downloaded file to your GTA 5 game directory. | ||
| 3. Launch the game and access the m0dmenu interface to start modding your gameplay. | ||
|
|
||
| ### Running the executable | ||
| ## Usage | ||
|
|
||
|  | ||
| Once installed, you can access the m0dmenu within the game by following these steps: | ||
|
|
||
| ### Caustics image | ||
| 1. **Open the Menu**: Press the designated hotkey to open the m0dmenu interface. | ||
| 2. **Navigate Options**: Use the arrow keys to navigate through the menu options. | ||
| 3. **Select Customizations**: Choose from a variety of cheats and customizations to apply to your gameplay. | ||
| 4. **Save Settings**: Save your settings to ensure they are applied every time you play GTA 5. | ||
|
|
||
|  | ||
| <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!) | ||
| ## Contributing | ||
|
|
||
| We welcome contributions to the m0dmenu for GTA 5 repository. If you have ideas for new features, improvements, or bug fixes, feel free to submit a pull request. Together, we can make the m0dmenu even more powerful and user-friendly for the GTA 5 community. | ||
|
|
||
| ## License | ||
|
|
||
| The m0dmenu for GTA 5 is licensed under the [MIT License](https://opensource.org/licenses/MIT). You are free to use, modify, and distribute this modding tool for non-commercial purposes. See the [LICENSE](LICENSE) file for more details. | ||
|
|
||
| --- | ||
|
|
||
| Thank you for downloading the m0dmenu for GTA 5! We hope you enjoy the enhanced gameplay experience and have fun exploring all the cheats and customizations available. If you have any questions or feedback, please feel free to reach out to us. Happy modding in Los Santos! 🚗💥🔫 |