GTA:O styled playerlist for FiveM servers (future proof: supports > 32 players).
- Configurable rows through a server event or export.
- Configured rows update live as soon as the event/export is called, even if someone has the playerlist open at that time.
- GTA:O scaleform used, so it looks exactly like GTA:O.
- Future proof, it supports more than 32 online players.
- "Server Name" indicator updates with the "sv_projectName" convar, defaults to "FiveM" if not set up.
- "Server Type" indicator updates with the "sv_serverType" convar, defaults to "Public" if not set up.
Download the latest version, drag the folder from the zip file into your resources folder and add start playerlist to your server.cfg file.
There is no config file to change any of the "visual" settings for player rows. You will have to create your own script to modify the rows through the playerlist api.
To change the player's row settings, trigger this server event:
TriggerEvent("fs:setPlayerRowConfig", 1 --[[ player id ]], "SNAIL" --[[ crew tag ]], 12 --[[ rank number ]], 50 --[[ job points ]], true --[[ show job points icon ]])| type | name | description |
|---|---|---|
| int | playerServerId | This is the player's server id for the player you want to change the row of. |
| string | crewText | The text to display for the "crew" tag behind the player's username. Pass an empty string ("") to disable the crew label. |
| int | rankNumber | The number to display for the "rank" value. Set to -1 to disable. |
| int | jobPointsAmount | The number to display for the "job points (jp)" value. Set to -1 to disable. |
| bool | showJobPointsIcon | Should the "(JP)" icon be visible next to the job points number? |
You can access this event from both C# or Lua scripts. By default the crew tag, job points amount and job points logo are all hidden for all players, only if you add them using the event will it make them visible for that specific player row. (syncing for all clients is managed by the resource)
You can also use the provided server export (setPlayerRowConfig()) however, due to some issues (possibly a bug with FiveM) this is kind of buggy now. Use the event for now, once I figure out why some parameters are not getting passed on when using the export I'll make sure to add documentation for the server export.
The information shown on the playerlist is configurable by using convars in your server.cfg file. Add the following to the server.cfg to set one up:
set sv_serverType "Private"| type | name | default | description |
|---|---|---|---|
| string | sv_projectName | "FiveM" | This is the server name that is shown in the server list, should already be set up. See this commit description for details. |
| string | sv_serverType | "Public" | This is the server type that is shown in the server list, you will need to add this convar if you want to use it. Set the convar to an empty string ("") to disable the server type from being shown. |
The default column is what will be shown for each convar if the convar has not been set up.
Download the resource on GitHub. Make sure to go to the "releases" page and download the latest release, don't download the repository as that's useless if you don't know how to use visual studio or don't want to edit the resource.
When in-game, press "Z" to open the first page, press "Z" again to go to the next page (just like the playerlist in GTA:O). If you're at the last page, pressing "Z" will close the playerlist. If the playerlist is open and you don't close it yourself, then it will auto-close after a couple of seconds. For controller support, use DPAD-DOWN.
Note, if other resources on your server disable the "Z" key or the "DPAD-DOWN" (INPUT_MULTIPLAYER_INFO / 20) control, then you won't be able to toggle the playerlist.
I edited the project to show the same information the playerlist in GTA Online gives you.
Here I will state the changes I made in this fork. The readme above is edited accordingly.
- Added the possibility to change the rank number. This removed the player's server ID as rank number.
- Removed "Max Players" indicator and replaced it with the current page number and the max amount of pages. This will be hidden if there is only 1 page.
- Added the possibility to change the server name. This will update to the "sv_projectName" convar and default to "FiveM" if the convar is not set up.
- Added the server type behind the server name. This will update to the "sv_serverType" convar and default to "Public" if the convar is not set up. It can be hidden by setting the convar to an empty string (
""). - Moved the playercount so that it shows behind the server type.
All credit goes to Tom Grobbe, I simply edited his work. You can find his original repository here.