Guad / NativeUI

UI library for Grand Theft Auto V
MIT License
272 stars 113 forks source link

"Official" FiveM version of NativeUI #99

Closed justalemon closed 3 years ago

justalemon commented 5 years ago

To avoid more those FiveM copies lying around on the internet, I have created an "Official" FiveM version of NativeUI. Is currently on the fivem branch and it requires some additional setup.

Until we decide for a way to release this version, there are some specific steps and requirements.

First, you need some prerequisites:

Getting the NativeUI files for FiveM

If using the Git command line

Run the following command from your project folder to add NativeUI as a submodule:

git submodule add -b fivem https://github.com/Guad/NativeUI.git NativeUI

If using a Git GUI

Check the documentation for your specific Git GUI.

Adding the NativeUI project

On Visual Studio, right click your Solution and select Add > Existing project... and search for NativeUI\NativeUI\NativeUI.csproj. Once found, double click it.

Restoring the missing packages

With Visual Studio 2017

Right Click the NativeUI project and select Manage NuGet Packages.... Then, you should see Some NuGet packages are missing.... Click the Restore button.

With the NuGet CLI

Run the following commands from your project folder:

cd NativeUI
nuget restore

Final steps

Finally, on the root of your project you should see the packages folder. Copy that folder and paste it inside of NativeUI.

Guad commented 5 years ago

I really think this is out of scope and should be on a fork. Especially when I've never used FiveM.

justalemon commented 5 years ago

I really think this is out of scope and should be on a fork.

That is the problem, there a lot of forks and all use the same "NativeUI" name or part of it. Including, but not limited to:

Especially when I've never used FiveM.

Don't worry, I use FIveM every day and I can keep this up to date with the master branch.

Guad commented 5 years ago

I just think it'd cleaner somewhere like justalemon/NativeUI and then endorsed in the README or something. The issues & PRs would get separated.

justalemon commented 5 years ago

We can use labels for that.

Imagine those libraries that have to support multiple frameworks under the same repo. With enough coordination everything stays in peace.

Guad commented 5 years ago

Well if you feel like you can manage that, then go ahead 👍

manups4e commented 5 years ago

@justalemon why not adding all the features from https://github.com/iTexZoz/NativeUILua-Reloaded ? it's the most complete lua NativeUI wrapper available.. but not usable by c# and actually i find Guad's the most easy to use versatile in c#.. Great Work u did!!

manups4e commented 5 years ago

i would also advice you to use the official nuget packages as they get constantly updated

justalemon commented 5 years ago

@manups4e We need to decide the package name and way to release it first, and I might port the rest of elements from the NativeUILua project.

manups4e commented 5 years ago

what you mean by package name and way to release it? It's NativeUI what else should it be called?

justalemon commented 5 years ago

Currently, we create a Git Tag for each new release. But because we can't have two tags with the same name, we need to find a way to store the code of that release.

For NuGet, we can't use the same package name for the other version. We might try NativeUI.FiveM or NativeUI.CitizenFX but that has to be decided with Guad.

manups4e commented 5 years ago

At this point I'd suggest you to create your own fork... If you want to keep it in a branch then its necessary to wait for guard to decide what to do

Il Gio 21 Mar 2019, 19:34 Hannele Ruiz notifications@github.com ha scritto:

Currently, we create a Git Tag for each new release. But because we can't have two tags with the same name, we need to find a way to store the code of that release.

For NuGet, we can't use the same package name for the other version. We might try NativeUI.FiveM or NativeUI.CitizenFX but that has to be decided with Guad.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Guad/NativeUI/issues/99#issuecomment-475352678, or mute the thread https://github.com/notifications/unsubscribe-auth/AD0ejoW1AnHmrJQMzXJFkRAYiwoQXgviks5vY9CigaJpZM4bG2fA .

manups4e commented 5 years ago

As for the name.. why not NativeUI.fivem

Il Gio 21 Mar 2019, 19:37 Emanuele colecchia manups4e@gmail.com ha scritto:

At this point I'd suggest you to create your own fork... If you want to keep it in a branch then its necessary to wait for guard to decide what to do

Il Gio 21 Mar 2019, 19:34 Hannele Ruiz notifications@github.com ha scritto:

Currently, we create a Git Tag for each new release. But because we can't have two tags with the same name, we need to find a way to store the code of that release.

For NuGet, we can't use the same package name for the other version. We might try NativeUI.FiveM or NativeUI.CitizenFX but that has to be decided with Guad.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Guad/NativeUI/issues/99#issuecomment-475352678, or mute the thread https://github.com/notifications/unsubscribe-auth/AD0ejoW1AnHmrJQMzXJFkRAYiwoQXgviks5vY9CigaJpZM4bG2fA .

manups4e commented 5 years ago

any news? i'd really need to have all the awesome features this menu could give but doesn't have yet ^^

justalemon commented 5 years ago

During the week I'm going to port some of the features.

manups4e commented 5 years ago

Awesome!!

Il Lun 1 Apr 2019, 09:09 Hannele Ruiz notifications@github.com ha scritto:

During the week I'm going to port some of the features.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Guad/NativeUI/issues/99#issuecomment-478461895, or mute the thread https://github.com/notifications/unsubscribe-auth/AD0ejpoWZ1ifklSC_l-oXHEhn1eOX_CBks5vcbCpgaJpZM4bG2fA .

justalemon commented 5 years ago

Have you created a git repo first? If no, just use git clone -repo-

manups4e commented 5 years ago

@BobbyTheDev that's something you have to code yourself... it's not like MenuApi... this is a different wrapper

manups4e commented 5 years ago

any news about newer features?

justalemon commented 5 years ago

@manups4e I ended up delaying the port of the new features because we are rewriting some of the classes that impact performance. See #108 for more information.

manups4e commented 5 years ago

i saw it :) no problem.. i tried port it myself but with no success XD

manups4e commented 5 years ago

any news? i'm impatiently waiting for newer features like heritage window and color panels 😍

justalemon commented 5 years ago

Sadly no, I had other projects and programming competitions in progress.

manups4e commented 5 years ago

Aaaawww that's ok real life is more important

Il mer 3 lug 2019, 16:48 Hannele Ruiz notifications@github.com ha scritto:

Sadly no, I had other projects and programming competitions in progress.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Guad/NativeUI/issues/99?email_source=notifications&email_token=AA6R5DRCCABNHAHH2E7QY2LP5S33DA5CNFSM4GY3M7AKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZEWEIA#issuecomment-508125728, or mute the thread https://github.com/notifications/unsubscribe-auth/AA6R5DULQLKQGKSX66D4W3TP5S33DANCNFSM4GY3M7AA .

manups4e commented 5 years ago

hey, i made the pull request for adding some cool features included panels and heritage windows

justalemon commented 3 years ago

Due to NativeUI being deprecated (see #136), the recommended thing to do is to use LemonUI NuGet Package. For more information, see the following pages: