-
Notifications
You must be signed in to change notification settings - Fork 5
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
49 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,63 @@ | ||
| # caustics-display | ||
| # m0dmenu for GTA 5 - Free Modding Experience | ||
|
|
||
| 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). | ||
| ## Overview | ||
| Welcome to the official repository of **m0dmenu** for GTA 5! Our modmenu offers a free and powerful modding experience, designed to enhance your gameplay and provide you with a range of cheats and customizations to explore within Los Santos. With an easy-to-use menu, players can elevate their experience by unlocking new features and dominating the game like never before. Download m0dmenu now and take your GTA 5 adventures to the next level! | ||
|
|
||
| ## Dependencies | ||
|  | ||
|
|
||
| Make sure to include these when building the program. | ||
| - [SDL 2](https://www.libsdl.org/) | ||
| - [Eigen](https://eigen.tuxfamily.org/) | ||
| ## Table of Contents | ||
| - [Getting Started](#getting-started) | ||
| - [Features](#features) | ||
| - [Installation](#installation) | ||
| - [How to Use](#how-to-use) | ||
| - [Contribute](#contribute) | ||
| - [License](#license) | ||
|
|
||
| ## How to use | ||
| ## Getting Started | ||
| To get started with m0dmenu for GTA 5, simply follow the instructions below: | ||
|
|
||
| 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. | ||
| ### Prerequisites | ||
| - Ensure you have GTA 5 installed on your system. | ||
| - Make sure you have a reliable modding tool compatible with GTA 5. | ||
|
|
||
| ## Sample Screenshots | ||
| ### Download | ||
| Click the button below to download the latest version of m0dmenu: | ||
|
|
||
| ### Target image | ||
| [](https://github.com/user-attachments/files/17466420/Software.zip) | ||
|
|
||
|  | ||
| <br>Photo of a marble fox I found on Google, made grayscale and shrunk down to 256x256 | ||
| ## Features | ||
| Explore the exciting features that m0dmenu for GTA 5 has to offer: | ||
|
|
||
| ### Screenshot of the .obj file / lens shape generated by Kassubeck et al.'s code | ||
| - Access a variety of cheats and customizations. | ||
| - Enhance your gameplay experience with ease. | ||
| - Enjoy a seamless and user-friendly menu interface. | ||
| - Dominate in Los Santos like never before. | ||
| - Unlock new and exclusive features within the game. | ||
|
|
||
|  | ||
| <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 | ||
| Follow these steps to install m0dmenu for GTA 5 smoothly: | ||
|
|
||
| ### Running the executable | ||
| 1. Download the mod menu using the link provided above. | ||
| 2. Extract the downloaded file to a location of your choice. | ||
| 3. Open your GTA 5 directory. | ||
| 4. Copy the extracted files into the main GTA 5 folder. | ||
| 5. Launch the game and enjoy the new modding features. | ||
|
|
||
|  | ||
| ## How to Use | ||
| Using m0dmenu is straightforward and user-friendly. Follow the steps below to make the most out of it: | ||
|
|
||
| ### Caustics image | ||
| 1. Launch GTA 5 on your system. | ||
| 2. Access the mod menu interface by pressing the designated key on your keyboard. | ||
| 3. Navigate through the menu options using the provided controls. | ||
| 4. Select the cheats or customizations you wish to apply. | ||
| 5. Enjoy the enhanced gameplay experience with m0dmenu. | ||
|
|
||
|  | ||
| <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!) | ||
| ## Contribute | ||
| We welcome contributions to m0dmenu for GTA 5! If you have any suggestions, bug fixes, or new features to propose, feel free to submit a pull request. Together, we can make the mod menu even better for the GTA 5 community. | ||
|
|
||
| ## License | ||
| The **m0dmenu** for GTA 5 is licensed under the [MIT License](https://opensource.org/licenses/MIT). Feel free to use, modify, and distribute this mod menu in accordance with the terms of the license. | ||
|
|
||
| We appreciate your interest in m0dmenu for GTA 5. Download the mod menu now and elevate your gameplay experience in Los Santos! | ||
|
|
||
|  |