diff --git a/README.md b/README.md index 0a61366..cd463fc 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,32 @@ +# GTA V Chaos Mod: Custom Lua Effects -# Gta 5 Chaos Mod Custom Lua Scripts +A collection of custom scripts designed to hook into the **GTA V Chaos Mod** framework. This project serves as both a playground for chaotic gameplay ideas and a practical way to explore game scripting. -A series of lua scripts for the [GTA 5 Chaos Mod](https://github.com/gta-chaos-mod/ChaosModV). +## 📌 Project Overview +The goal of this repository is to expand the existing pool of effects in the GTA V Chaos Mod. These scripts introduce new world events, player debuffs, and unpredictable environmental changes using the Lua scripting language. -## Documentation +## 🧠 What I Am Learning -For scripting references to build your own scripts. You can look at the Chaos Mod's wiki [here](https://github.com/gta-chaos-mod/ChaosModV/wiki/Lua-Scripting). +This project is a hands-on exercise in game modding and logic design. Through this repo, I am developing skills in: +* **Lua Scripting:** Understanding syntax, tables, and functional programming within a sandboxed environment. +* **Game State Manipulation:** Learning how to interface with the GTA V engine to modify entities, weather, physics, and player variables in real-time. +* **Event-Driven Programming:** Managing how effects trigger, duration timers, and cleanup processes to ensure the game doesn't crash. +* **Problem Solving:** Debugging complex interactions where multiple scripts might attempt to modify the same game value simultaneously. -This project is covered by the MIT license, allowing users to modify the code to their own preferences. -[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/) +## 🛠️ Current Focus +* Creating unique "Twitch-integrated" style effects. +* Optimizing scripts to maintain high frame rates during high-chaos events. +* Learning the native GTA V "Natives" (API functions) to unlock deeper control over the game world. +--- +### How to Use -## Authors - -- [nathan-falvey/nathan](https://gitea.nathan-falvey.synology.me/nathan) +1. Ensure you have the [GTA V Chaos Mod](https://github.com/gta-chaos-mod/ChaosModV) installed. +2. Download the `.lua` files from this repository. +3. Place them in your `ChaosMod/Effects` directory. +---