Update readme.md

This commit is contained in:
Linden
2021-06-14 20:56:19 +10:00
committed by GitHub
parent 83e25bc5e4
commit 1ebb812b1c
+25 -24
View File
@@ -1,17 +1,9 @@
### Requirements
#### [ESX Legacy](https://github.com/esx-framework/es_extended/tree/legacy)
- Minimum commit: 89f8d87
- Legacy is an update from v1 Final with bug fixes, optimisations and some new features
#### [MySQL Async](https://github.com/brouznouf/fivem-mysql-async/releases/tag/3.3.2)
- Minimum commit: ec81359
#### [ESX Identity](https://github.com/esx-framework/esx_identity)
- Minimum commit: 5d28b23
- Required for character registration
#### [ESX Skin](https://github.com/esx-framework/esx_skin)
- Minimum commit: 3a81208
- If you wish to use other resources, you will need to adjust events in multicharacter
#### [Spawnmanager](https://github.com/citizenfx/cfx-server-data/tree/master/resources/%5Bmanagers%5D/spawnmanager)
- Required for spawning as well as ESX Legacy
- [ESX Legacy](https://github.com/esx-framework/es_extended/tree/legacy)
- [MySQL Async](https://github.com/brouznouf/fivem-mysql-async/releases/tag/3.3.2)
- [ESX Identity](https://github.com/esx-framework/esx_identity)
- [ESX Skin](https://github.com/esx-framework/esx_skin)
- [Spawnmanager](https://github.com/citizenfx/cfx-server-data/tree/master/resources/%5Bmanagers%5D/spawnmanager)
### Installation
- Modify your ESX config with `Config.Multichar = true`
@@ -19,6 +11,26 @@
- All owner and identifier columns should be set to `VARCHAR(60)` to ensure correct data entry
- Use the `varchar` command from the console to update your SQL tables
- Once you have used the command you should just remove it for sanity's sake
### Conflicts
* The following resources should not be used with ESX Legacy and can result in errors
- **essentialsmode**
- basic-gamemode
- fivem-map-skater
- fivem-map-hipster
- default_spawnpoint
- cui_character (or other resources that modify spawn behaviour)
### Common issues
#### Black screen / loading scripts
- Download and run all requirements
- Ensure none of the conflicting resources are enabled
#### mysql-async duplicate entry
- You have not increased the VARCHAR size of your tables (use the command)
#### The menu interface is esx_menu_default - you can use any version if you want a different appearance
![image](https://user-images.githubusercontent.com/65407488/119010385-592a8c80-b9d7-11eb-9aa1-eb7051004843.png)
### Relogging
- Modify the config with `Config.Relog = true`
- Use the latest version of [ESX Status](https://github.com/esx-framework/esx_status)
@@ -41,17 +53,6 @@ AddEventHandler('esx:onPlayerLogout', function()
end)
```
#### The menu interface is esx_menu_default - you can use any version if you want a different appearance
![image](https://user-images.githubusercontent.com/65407488/119010385-592a8c80-b9d7-11eb-9aa1-eb7051004843.png)
## Conflicts
* The following resources should not be used with ESX Legacy and can result in errors
- **essentialsmode**
- basic-gamemode
- fivem-map-skater
- fivem-map-hipster
- default_spawnpoint
### Notes
- This resource is not compatible with ExtendedMode or previous versions of ESX
- Legacy, skin, and identity must be updated to at least the minimum commits specified above