Introducing NucleiLite

Hello fellow Developers,

I'd like to share with you a project I've been working on - a guide to developing mods for Grand Theft Auto V aimed at beginners.

Together, we'll create a mod that offers menus allowing players to access various options related to health, armor, invincibility, and super jump abilities, all created using the ScriptHookVDotNet Framework and LemonUI Framework. The menus contain interactive items, including regular items, checkboxes and list items, which make it easy for the player to activate specific features.

NucleiLite also includes features for spawning vehicles and providing the player with all the weapons available in the game, using various native items to create menus and activate features.

There's an associated Wiki-page that offers both a Simplified Version, designed for those with no developing background, and an Advanced Version, which delves into the concepts of C# and the ScriptHookVDotNet and LemonUI Libraries. The Wiki-page provides in-depth explanations, images, and examples, making it easy for beginners to follow along.

The mod includes events that react to user inputs such as key presses, list item changes and checkboxes, as well as a Tick event that continuously checks for specific conditions to execute code.

Feature List

• Getting Started with Visual Studio Code
• Creating your First Script
• Six standalone scripts that are activated with KeyPresses
  • Fix Player Script
  • Invincible Script
  • Adjust Wanted Level Script
  • Super Jump Script
  • Spawn Vehicle Script
  • Give All Weapons Script
• Setting up an IDE
• A menu (F5) that implements each script using LemonUI
  • A Main Menu (NativeMenu) with three sub menus
    • Player Menu (NativeMenu)
      • Fix Player Item (NativeItem)
      • Invincible Checkbox (NativeCheckboxItem)
      • Wanted Level ListItem (NativeListItem)
      • Super Jump Checkbox (NativeCheckboxItem)
    • Vehicle Spawner Menu (NativeMenu)
      • A list of items (NativeItem) that represents each vehicle in game
    • Weapons Menu (NativeMenu)
      • Give All Weapons (NativeItem)

Find it on GitHub

Both the mod and its associated Wiki-page can be found at GitHub

NucleiLite - Source Code
NucleiLite - Wiki

If you just want to see what we'll be building together, you can download the release here
NucleiLite - Release

Where to Next?

There is a lot of concepts, best practices, functionality and code improvements we didn't cover in the NucleiLite version - however i'm working on a Complete Mod Menu with 100+ features, every NativeItem covered, services, abstract classes, generics, and much more using ScriptHookVDotNet and LemonUI called Nuclei - this will also have an associated Wiki-page

The Nuclei is an early work-in-progress and the Wiki needs an overhaul, you can follow along as I continue the Jouney there.

Nuclei - Source Code
Nuclei - Wiki

Feedback

Thank you for taking the time to check out my project, NucleiLite. I hope you found it informative and helpful for your modding experience in Grand Theft Auto V.

I would love to hear your feedback on the project, including any suggestions or improvements you would like to see. Did you find the explanations clear and easy to follow? Were the examples helpful? Is there anything you feel was missing or could have been improved upon?

Your feedback is important to me and will help me to continue to develop useful resources for the modding community. Thank you again for your time and consideration.

@JohnFromGWN

Thanks man! I'm "done" with the basic NucleiLite edition sometime tomorrow I think.

Edit: There's a new tomorrow tomorrow. Soo...... yeah.

Edit edit: Sometimes life happens, and yeah...

Would someone mind giving me feedback on the following Wiki

Everything from the beginning of the Table of Content to the Fix Player script section is currently updated.

https://github.com/KimonoBoy/SHVDNTutorial-NucleiLite/wiki

@JohnFromGWN said in [Request for Feedback] - Guide to Developing GTA V Mods with ScriptHookVDotNet and LemonUI - Help Improve My Step-by-Step Guide!:

@KimonoBoy

Here is a very very useful script. It allows you to go through any obstacles or barriers, on foot or in a vehicle.
I use it every time I play, simple key press gets me out of trouble.
Also, in a vehicle this will stop a car instantly.

 if (e.KeyValue == 187) // Teleport Forward on = key, this is also an instant stop in a car!
                {
                if (!Game.Player.Character.IsInVehicle())
                {
                    var myPos = Game.Player.Character.Position + Game.Player.Character.ForwardVector;
                    Vector3 myForward = new Vector3(myPos.X, myPos.Y, myPos.Z - 1f);
                    Game.Player.Character.Position = myForward;
                }
                else
                {
                   Vehicle MyCar = Game.Player.Character.CurrentVehicle;
                    MyCar.Position += MyCar.ForwardVector * 4.5f;
                }

               }

Thanks! I think we can find a place for this code.

Been really busy the last couple of days. Hoping to get some work done this weekend.

The Lite version can be found here

NucleiLite
NucleiLite - Wiki

Off to bed. To be continued.

@JohnFromGWN said in [Request for Feedback] - Guide to Developing GTA V Mods with ScriptHookVDotNet and LemonUI - Help Improve My Step-by-Step Guide!:

@KimonoBoy perfect. I wrote the most useful one line script if you want it.

Sure! Everything is welcome. I actually think I'll divide it into two different mods and Wiki:

Nuclei-Lite - Beginners Guide to writing .NET scripts for GTA V. I'm thinking of the following:

• Installation Process
• Quick introduction to Core Concepts of C# using the GTA V as the "environment" rather than a Console.

• Data Types
• Variables
• Comments
• Fields and Properties
• Methods
• Classes
• if/else
• for, foreach and while
• Arrays/Collections
• Events
• Others?

• A mod menu using LemonUI with 3 submenus that covers all the topics above.

• Player

  • Fix Player
  • Invincible
  • Wanted Level
  • Super Jump

• Vehicle

  • Spawn Vehicle

• Weapon

  • Give All Weapons

• And then a teleportscript on key press.

Note: I won't divide the guide into the sections above, i'll write scripts and then cover the subjects as we go and share resources. Maybe we'll create a Notification script first and explain Data Types.

Nuclei - Complete Mod, as of now every section of the current wiki also needs to be more thorough, with detailed explanation and thought process. With this in mind, the beginners guide should be finished first as it's the quickest to complete and the "advanced" full mod will be put on pause for now.

@JohnFromGWN
I'm thinking to split the wiki into two sections - a "Getting Started" section where we cover the basics of writing scripts to .cs files and use e.g. VS Code or notepad++ to write 10 different features and then an Advanced Section to make the complete mod of Nuclei with VSStudio and compiled scripts (.dll).

@JohnFromGWN said in [Request for Feedback] - Guide to Developing GTA V Mods with ScriptHookVDotNet and LemonUI - Help Improve My Step-by-Step Guide!:

@KimonoBoy This is by far the best documentation for LemonUI available and I would also say the most organized documentation for GTA 5 scripting I've personally seen. Highly recommended.

I haven't had time to go through the wiki, but 2 things came to mind that could challenge a beginner:

1. In some sections, the comment lines drown out the actual lines of code. This makes the code look much more daunting than it is although I fully understand the rationale. Not sure how you can or if you can address this. Hyperlinking would be an unpractical option. Hovering, although I doubt Github supports it, would be ideal.

The comment lines you are referring to are documentation - this is used to display information to the IDE when calling the method. It's intentional - but maybe you are right, maybe it should just be in the source code and not part of the guide.

2. Visual Studio, for non-programmers, can be overwhelming. Particularly for those who have trouble installing ScripthookV, let alone a full IDE. While it definitely is the route to follow, absolute beginners might be encouraged to start - and to continue their journey - by creating uncompiled scripts - perhaps using vcode as an editor to help with the syntax. For example, having rainbow braces.

Thinking of something like a simple script with e.g. 5 features? Some keybinding and ticks to do a few different things? I didn't experience the IDE issues you're referring to when I learned software development, but I guess some people might - I can add this as it's own section in the wiki og maybe create a new repository with a mod and a small wiki? What do you suggest?

Edit: I sounded kind of condescending - was not my intention!

Hello everyone,

I'm excited to share my latest project with the GTA V modding community - a comprehensive guide to developing mods using ScriptHookVDotNet and LemonUI. My goal is to provide a clear and detailed guide that will help modders of all levels create their own mods from start to finish.

I've worked hard to create a step-by-step guide that covers everything from setting up your development environment to creating a complete mod. You can find the guide on my GitHub repository, along with the associated Wiki that provides a step-by-step development guide + additional information and resources.

Nuclei
Wiki

Now, I need your help to make this guide even better! I'm looking for feedback on the following areas:

Clarity: Is the guide easy to follow and understand?

Organization: Is the information presented in a logical and accessible way?

Comprehensiveness: Does the guide cover everything you need to know to develop a complete mod menu?

I welcome all feedback, positive or negative, and would be grateful for any suggestions you have on how I can improve this guide. Your input will help me make this guide the best it can be for the GTA V modding community.

Thank you for your time and support!

Best regards,
KimonoBoy

Note

Please note that no section in the Wiki is in a finite state. Everything will be revisited and properly documented.