diff --git a/README.md b/README.md index d0b33aee..819de528 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # es_extended -es_extended is an extention that is developed on top of [EssentialMode](https://essentialmode.com/) (aka ES), thus commonly named ESX - the **Es**sentialMode **E**xtended framework for FiveM. +es_extended is a roleplay framework for FiveM. It is developed on top of [EssentialMode](https://essentialmode.com/) (aka ES), thus commonly named ESX - the **Es**sentialMode **E**xtended framework for FiveM. ### Links & Read more - [Official Discord community](https://discord.me/fivem_esx) -- [ESX Documentation](https://esx-org.github.io/) (things are missing!) +- [ESX Documentation](https://esx-org.github.io/) (incomplete) - [ES Documentation](https://docs.essentialmode.com/) - [FiveM Native Reference](https://runtime.fivem.net/doc/reference.html) @@ -30,28 +30,15 @@ This order also applies in the startup order. ### Download & Installation -**1) Using [fvm](https://github.com/qlaffont/fvm-installer)** - +### Using [fvm](https://github.com/qlaffont/fvm-installer) ``` fvm install --save --folder=essential esx-org/es_extended fvm install --save --folder=esx esx-org/esx_menu_default fvm install --save --folder=esx esx-org/esx_menu_dialog fvm install --save --folder=esx esx-org/esx_menu_list - ``` -**2) Manually** - -- Download https://github.com/ESX-Org/es_extended/releases/latest -- Put it in the resource/[essential] directory -- Download https://github.com/ESX-Org/esx_menu_default/releases/latest -- Put it in the resource/[esx]/[ui] directory -- Download https://github.com/ESX-Org/esx_menu_dialog/releases/latest -- Put it in the resource/[esx]/[ui] directory -- Download https://github.com/ESX-Org/esx_menu_list/releases/latest -- Put it in the resource/[esx]/[ui] directory - -**3) Using git** +### Using Git ``` cd resources @@ -61,10 +48,20 @@ git clone https://github.com/ESX-Org/esx_menu_dialog [esx]/[ui]/esx_menu_dialog git clone https://github.com/ESX-Org/esx_menu_list [esx]/[ui]/esx_menu_list ``` -## Installation +### Manually +- Download https://github.com/ESX-Org/es_extended/releases/latest +- Put it in the `resource/[essential]` directory +- Download https://github.com/ESX-Org/esx_menu_default/releases/latest +- Put it in the `resource/[esx]/[ui]` directory +- Download https://github.com/ESX-Org/esx_menu_dialog/releases/latest +- Put it in the `resource/[esx]/[ui]` directory +- Download https://github.com/ESX-Org/esx_menu_list/releases/latest +- Put it in the `resource/[esx]/[ui]` directory -1) Import es_extended.sql in your database -2) Configure your `server.cfg` to look like this + +## Installation +- Import `es_extended.sql` in your database +- Configure your `server.cfg` to look like this ``` start baseevents