Mods / PlayerList

Tags: #Other #QoL
Author: BillyGalbreath
Side: Client
Created: Jul 28th 2023 at 9:05 AM
Last modified: Nov 17th at 2:19 AM
Downloads: 126904
Follow Unfollow 543

Recommended download (for Vintage Story 1.21.0 - 1.21.5):
PlayerList-2.3.4.zip  1-click install


Shows a player list when you hold down tab (similar to Minecraft).

 

-------------------------------------------------------------------------------------------------------------

 

You can configure the ping thresholds using the config file at "VintagestoryData/ModConfig/playerlist.json"

You can set these for your own client, or your entire server. Server values have a higher priority.

 

-------------------------------------------------------------------------------------------------------------

 

Servers can add their own header and footer text and even a logo image to the list. Just open the playerlist.json file and add the strings you want. VTML is supported.

These variables are also supported:

  • ServerName - Displays the server name that's specified in serverconfig.json
  • MaxPlayers - The maximum number of players allowed
  • CurPlayers - The current amount of connected players
  • Month - The in-game month
  • Day - The in-game day
  • Year - The in-game year

An example for most of these variables can be seen on my Pl3x server.

Here is the config for that:

{
  "thresholds": [ 100, 250, 500 ],
  "logo": "",
  "header": "<strong>Pl3x - {Month} {Day}, Year {Year}</strong>\n<i>\u2014\u005b {CurPlayers}/{MaxPlayers} \u005d\u2014</i>",
  "footer": "<i>discord.gg/JXra7N4\nvs.pl3x.net/map</i>"
}

 

 

-------------------------------------------------------------------------------------------------------------

 

 

The logo image can be configured, as well.

 

Default logo image:

image

{
  "thresholds": [ 100, 250, 500 ],
  "logo": "playerlist:textures/vs_logo.png"
}



Sample custom logo:

image

{
  "thresholds": [ 100, 250, 500 ],
  "logo": "https://i.imgur.com/RoAU85m.png"
}

 

-------------------------------------------------------------------------------------------------------------

Remember, I build these mods for myself and my family. Not you. I owe you nothing. I just like sharing what I've built with others for free. You will receive minimal to no support when using any of my mods.

-------------------------------------------------------------------------------------------------------------

Mod Version Mod IdentifierFor Game version Downloads Released Changelog Download 1-click mod install*
2.3.4 playerlist
1.21.0 - 1.21.5
4629 Nov 17th at 2:19 AM PlayerList-2.3.4.zip 1-click install

[903533a] add ability to load images from asset location
[74cffbc] change default logo to locally stored asset

2.3.3 playerlist
1.21.0 - 1.21.5
3925 Nov 12th at 1:13 AM PlayerList-2.3.3.zip 1-click install

[c5f21ea] a little code cleanup
[049fa00] show missing image icon if logo errors

2.3.2 playerlist
1.21.0 - 1.21.5
407 Nov 11th at 7:56 PM PlayerList-2.3.2.zip 1-click install

[e817d86] add configurable name truncation, default 20 characters

2.3.1 playerlist
1.21.0 - 1.21.5
95 Nov 11th at 4:23 PM PlayerList-2.3.1.zip 1-click install

[38778fc] fix scaling issue

2.3.0 playerlist
1.21.0 - 1.21.5
104 Nov 11th at 2:16 PM PlayerList-2.3.0.zip 1-click install

[0d279cb] add logo image support

2.2.0 playerlist
1.21.0 - 1.21.5
325 Nov 10th at 10:18 PM PlayerList-2.2.0.zip 1-click install

[7f9ebc4] update project
[98753a3] update default thresholds
[c3c1ced] refactor for optimizations
[b1fe2b6] more optimisations
[ce29f92] code formatting
[08f49c9] fix footer padding issue
[5bf6782] remove debug stuff
[9ab6ab9] no jumps
[3cba1b4] update to 1.21.0 to match net8 requirement

2.1.5 playerlist
1.19.4 - 1.21.5
77771 Dec 21st 2024 at 4:35 PM PlayerList-2.1.5.zip 1-click install

[71a72d6] update csproj
[ed8bda2] Fix bug cutting off player names
[0c48f71] fix ambiguous cairo imports.

2.1.4 playerlist
1.19.4 - 1.20.0-rc.6
8946 Aug 1st 2024 at 6:10 PM PlayerList-2.1.4.zip 1-click install

[92950ad] another try at fixing the null reference

2.1.3 playerlist
1.19.4 - 1.19.8
203 Aug 1st 2024 at 5:43 PM PlayerList-2.1.3.zip 1-click install

[5bb1b1d] fix possible null reference

2.1.2 playerlist
1.19.4 - 1.19.8
4528 Jun 16th 2024 at 9:09 AM PlayerList-2.1.2.zip 1-click install

[af1ffd5] rewrite ui from ground up

2.1.1 playerlist
1.19.4 - 1.19.8
456 Jun 15th 2024 at 5:27 AM PlayerList-2.1.1.zip 1-click install

[849fdaf] fix vtml getting squished on some screens
[fc0f632] cleanup box spacings
[098482b] a little more spacing tweaks

2.1.0 playerlist
1.19.4 - 1.19.8
173 Jun 15th 2024 at 2:25 AM PlayerList-2.1.0.zip 1-click install

[f85fa94] set up run configurations
[a2a06bf] ensure modconfig directory exists
[e250abb] try to calculate correct icon y position
[5cbf358] looks good on windows
[17a9e33] update list immediately when opening
[76fdd2a] change to transparent theme
[02202d7] silence rider's unused class warning
[207499b] add header and footer support for servers
[49cba81] provide full debug files in mod

2.0.4 playerlist
1.19.4 - 1.19.8
761 Jun 12th 2024 at 10:31 PM PlayerList-2.0.4.zip 1-click install

[4a3065a] more cleanup
[cbe34fe] fix file watcher not detecting config changes

2.0.3 playerlist
1.19.4 - 1.19.8
190 Jun 12th 2024 at 8:41 PM PlayerList-2.0.3.zip 1-click install

[2ca5e0a] fix client overriding server thresholds after reload

2.0.2 playerlist
1.19.4 - 1.19.8
304 Jun 12th 2024 at 8:11 PM PlayerList-2.0.2.zip 1-click install

[eed4de6] fix protobuf issue on servers

2.0.1 playerlist
1.19.4 - 1.19.8
172 Jun 12th 2024 at 7:57 PM PlayerList-2.0.1.zip 1-click install

[b5f15a7] code cleanup
[6eae8d8] fix unknown ping icon (maybe)
[b34bc8c] better modicon image

2.0.0 playerlist
1.19.4 - 1.19.8
212 Jun 12th 2024 at 7:26 PM PlayerList-2.0.0.zip 1-click install

[3979858] major refactor and switch yaml to json
[c5c34a2] add columns for longer lists of players

1.8.1 playerlist
1.19.4 - 1.19.7
4285 Apr 29th 2024 at 5:15 AM PlayerList-1.8.1.zip 1-click install

Note: This version drops support for all versions below 1.19.4 due to a game bug in multiplayer that created an endless download loop. If you use one of these versions you can stick to v1.8.0 of this mod. Nothing else of importance has been updated.

[ea295d5] update .editorconfig
[5bf0cb7] null out variables on dispose
[0f8a7f6] update modinfo.json now that 1.19.4 fixed a game bug

1.8.0 playerlist
1.18.8 - 1.19.7
5159 Feb 7th 2024 at 4:43 PM PlayerList-1.8.0.zip 1-click install

[eb85715] make ping thresholds configurable (client and server sides)

1.7.4 playerlist
1.18.8 - 1.19.3
806 Feb 4th 2024 at 7:43 PM PlayerList-1.7.4.zip 1-click install

[a3a7ef3] fix color cloning issue

1.7.3 playerlist
1.18.8 - 1.19.3
759 Jan 30th 2024 at 2:47 PM PlayerList-1.7.3.zip 1-click install

[89e1253] fix possible edge case concurrent issues

1.7.2 playerlist
1.18.8 - 1.19.3
475 Jan 28th 2024 at 1:26 AM PlayerList-1.7.2.zip 1-click install

[7dfec56] Add ukr lang
[895caf0] remove broken modinfo sides until VS team fixes

1.7.1 playerlist
1.18.8 - 1.19.3
261 Jan 24th 2024 at 9:28 PM PlayerList-1.7.1.zip 1-click install

DO NOT DOWNLOAD - THIS VERSION IS BROKEN!

[6b3565a] let's try this side combination

1.7.0 playerlist
1.18.8 - 1.19.3
195 Jan 24th 2024 at 9:10 PM PlayerList-1.7.0.zip 1-click install

DO NOT DOWNLOAD - THIS VERSION IS BROKEN!

[19e286d] style and convenience changes
[297a22f] require minimum 1.18.8 version of the game
[5efad3c] fixup required side stuff in modinfo.json

1.6.0 playerlist
1.18.8 - 1.19.3
7390 Sep 14th 2023 at 4:08 PM PlayerList-1.6.0.zip 1-click install

[f3e2406] switch project to rider ide
[edbbb00] cleanup the code a bit
[4091b91] update list every second while open
[e5a3a15] add polish translation (thanks Kaofan \o/)

1.5.2 playerlist
1.18.8 - 1.18.10
690 Sep 7th 2023 at 12:37 AM PlayerList-1.5.2.zip 1-click install

[3078bc9] add lang file for translations

1.5.1 playerlist
1.18.0 - 1.18.8
1005 Aug 10th 2023 at 6:03 AM PlayerList-1.5.1.zip 1-click install

fix player list not showing up at all

1.5.0 playerlist
1.18.0 - 1.18.8
244 Aug 10th 2023 at 3:22 AM PlayerList-1.5.0.zip 1-click install

fix players remaining on tab list after disconnecting

1.4.0 playerlist
1.18.0 - 1.18.7
362 Aug 6th 2023 at 12:04 PM PlayerList-1.4.0.zip 1-click install

Fixed issue where client side only installs did not correctly handle keyboard/mouse inputs

1.3.0 playerlist
1.18.0 - 1.18.7
354 Aug 3rd 2023 at 1:42 PM PlayerList-1.3.0.zip 1-click install

no longer require server side for ping

1.2.0 playerlist
1.18.0 - 1.18.6
385 Jul 29th 2023 at 11:23 PM PlayerList-1.2.0.zip 1-click install

add support for colored entitlements (thanks for the suggestion DanaCraluminum)

1.1.1 playerlist
1.18.0 - 1.18.6
279 Jul 29th 2023 at 3:00 AM PlayerList-1.1.1.zip 1-click install

remove left over debug spam

1.1.0 playerlist
1.18.0 - 1.18.6
257 Jul 29th 2023 at 2:54 AM PlayerList-1.1.0.zip 1-click install

add ping icons

1.0.2 playerlist
1.18.0 - 1.18.6
269 Jul 28th 2023 at 9:47 AM PlayerList-1.0.2.zip 1-click install

apparently also has to be marked as required on server..

1.0.1 playerlist
1.18.0 - 1.18.6
266 Jul 28th 2023 at 9:38 AM PlayerList-1.0.1.zip 1-click install

Changed side to "Universal" so servers will send the mod to clients.

1.0.0 playerlist
1.18.0 - 1.18.5
262 Jul 28th 2023 at 9:09 AM PlayerList-1.0.0.zip 1-click install

Initial release.


54 Comments (oldest first | newest first)

💬 IISFROG, 3 days ago

why does the image not work? I added a custom one to imgur and it dont work

 

💬 Teax, Nov 22nd at 6:57 PM

Great mod. Love it!
Would a current time variable also a possibility?

💬 YangWenLi, Nov 19th at 5:05 PM

Fantastic mod, keep up the good work!

💬 Stason4ikRU, Nov 17th at 9:28 AM

Thanks for update!

💬 BillyGalbreath , Nov 17th at 1:55 AM (modified Nov 17th at 2:21 AM)

v2.3.4 now uses a local copy of the vs logo as the default image.

💬 Cecer, Nov 16th at 11:02 PM (modified Nov 18th at 5:51 AM)

BillyGalbreath The missing image isn't super helpful as Imgur decided to simply transparently send a fallback image requests made from the UK. There isn't a clean way around this but at very least I assume you'd rather it not be "broken" by default.

Here is what it looks like on a busy server at 1080p with a GUI scale of 7 (any higher and it goes off the screen):

image

(I decided to go to the extra effort of uploading this to imgur because I found the irony amusing - hope you enjoy)

 

This doesn't actually impact me that much because I don't play on a 1080p screen but I figured this probably isn't the out of the box experience you had in mind. I've also made a post in the server in question suggesting that they may wish to change their config settings away from the current default.

💬 Stason4ikRU, Nov 15th at 2:35 PM

Please make it possible to download images from the archive. Sites remove images over time

 

💬 BillyGalbreath , Nov 11th at 11:40 PM (modified Nov 12th at 1:14 AM)

You can use any image you want hosted from anywhere you want Aphaeleon

I went ahead and added a "missing image" icon if the logo fails to load in v2.3.3

💬 Aphaeleon, Nov 11th at 11:30 PM

the latest update breaks the mod for UK players because it uses imgur, we just have a giant error now

💬 SiiMeR, Nov 11th at 8:02 PM

Thanks a lot for the update! I will give it a go.

 

The nicknames come thanks to The Basics mod I think, which allows you to adjust it for roleplay purposes. 

💬 BillyGalbreath , Nov 11th at 7:58 PM

Oh wow, those are some long names. I thought the game had a limit on name length. Now I know there isn't lol

Ok, so I tested with these names:


[
"BillyGalbreath",
"This is a Stupidly Long And Annoying Name",
"Lord Paramount Adonias Merrick of the Heartlands, Hand of the King",
"Bob"
]

 

And with the new configurable max name length option with the default of 20 characters we get this

image

 

This can be configured by client and/or server in v2.3.2, but the server's setting always takes precedence SiiMeR

💬 SiiMeR, Nov 11th at 7:33 PM

 

Here is an example of the long nicknames people sometimes use. 

💬 BillyGalbreath , Nov 11th at 7:20 PM

I can add a limit. That's a good idea. Can you give me an example name to test with? SiiMeR

💬 SiiMeR, Nov 11th at 7:16 PM

Hey, I love your mod. It is a staple for any multiplayer server. I wanted to ask if there was a way to set max username length to be shown? If someone puts all their noble titles into a username, it makes the playerlist not fit on the screen, leading to bad experience.

💬 BillyGalbreath , Nov 11th at 4:24 PM

Thanks, Pizza. It should be fixed in v2.3.1

💬 Pizza, Nov 11th at 3:55 PM

Changing GUI scale messes up the window, including the logo image.

💬 BillyGalbreath , Oct 9th at 8:04 PM

disputedname This is a client side mod, but it can optionally be installed on the server, yes. When it is installed on the server it forces all connecting clients to download it.

💬 disputedname, Oct 8th at 5:42 PM

Didn't this used to be serverside?

💬 Loveless, Sep 5th at 10:52 AM

Works fine on 1.21.1

💬 RotYoger, Aug 30th at 7:26 PM (modified Aug 30th at 7:33 PM)

BillyGalbreath

Oh, then the problem is something else, a different mod or something
Thanks for the answer and the mod

💬 BillyGalbreath , Aug 29th at 9:33 PM (modified Aug 29th at 9:43 PM)

image

2.1.5 works fine for me on 1.21.0 (which is why i marked it as so) Tehgarin RotYoger

Here's screenshot of the mod running on The Official Public Server on version 1.21.0 (ignore the ugly font, i dont know why the game has ugly fonts on linux)



image

💬 Tehgarin, Aug 29th at 8:22 PM

will there be an update  to 1.21.0.. ??

💬 RotYoger, Aug 29th at 3:56 PM (modified Aug 29th at 4:02 PM)

does not work in 1.21.0v

💬 LeuxSeveN, May 18th at 3:10 AM

1.20.10?

💬 Zadak, Apr 17th at 3:40 PM

Camoman

Have you even bothered looking at the provided images? It's literally there.

💬 Camoman, Mar 26th at 6:32 PM

How do I change the keybind?

💬 DejFidOFF, Jun 18th 2024 at 7:02 AM

BillyGalbreath

Some version after 0.7.4 did not work for me, maybe some crossmod error. But the latest works. Is it possible to setup a bigger gui in config?

💬 BillyGalbreath , Jun 15th 2024 at 2:27 AM

It's working fine for me and everyone else, DejFidOFF

💬 DejFidOFF, Jun 14th 2024 at 9:41 PM

2.0.4 Not working. mod cuts end of the names. Still using 0.7.4 because this one only work properly at my server.

💬 BKS_Kit, Jun 8th 2024 at 12:55 PM
 

Hello, I don't understand why this mod doesn't work in my world when I install it. I searched through the commands to find the keys, but they don't appear in the list.

💬 BillyGalbreath , Jun 2nd 2024 at 11:15 AM

This is by design. If you have it installed on the Server then all connecting Clients will be required to download it, too, KxttyKxt

💬 KxttyKxt, Jun 2nd 2024 at 1:35 AM

Hey! This mod's selected "Side" is Client, but my friend had to download it to join my world. Just wanted to let you know.

💬 MadGnome, Apr 26th 2024 at 9:22 PM

Love the mod, super handy for a server.

I do see the options in the config for a threshold which is nice.  If you are ever looking to do an update, ever consider having a configuration option to switch out the good/avg/bad connection image with the clients actual ping number?  Perhaps color coded along with the same stats for the thresholds.

Either way, thanks for this simple and yet awesome mod!

💬 BillyGalbreath , Feb 9th 2024 at 4:44 PM

Ricodemus It's not a "target", but a "minimum version" - if I bump it to 1.19.0 then the warning goes away in 1.19.x versions of the game, but then 1.18.x clients wont be able to use it anymore. ;)

💬 Ricodemus, Feb 9th 2024 at 3:27 PM

Your modinfo.json is still targeting "game": "1.18.8"

💬 BillyGalbreath , Jan 30th 2024 at 2:48 PM

Thank you for the report BarenAD.

I have released a possible fix (if it was caused by this mod, at least) ^_^

💬 BarenAD, Jan 30th 2024 at 12:02 PM

BillyGalbreath

hi! I found compatibility issues with the following mods: PlayerList with Status Hud Continued. See youtube video for full demonstration:
In short: in the presence of both mods and when a player is excluded, a crash occurs. But if you open the inventory, there is no problem. This is especially critical when using a the mod FairPlayGuardian because players are excluded for mods, but they crumble and cannot understand the problem.
I do not know what the problem is, so I informed both authors about it :)
Logs

💬 DisorderlyF, Jan 28th 2024 at 5:08 PM

BillyGalbreath Apologies for the poor wording. We are in agreement about the takeaway. I simply felt the need to point out that the experience on Linux is slightly more complicated as well. I opted for an unofficial packaging of 7zip for Linux, as my usual archival program, XArchiver, was not working. If it does in fact work with Ark or File Roller, I will use those in future. Either way, I'm no longer running into issues as long as I edit directly from the archive as opposed to extracting and recompressing.

💬 BillyGalbreath , Jan 20th 2024 at 1:41 PM

You could have used any archive program of your own preference. I just assume people use windows (it's a safe assumption) so I recommend the best for that platform, which is 7zip. As for linux, the standard Ark or File Roller, etc would suffice.

The takeaway you should have got was to open the archive and edit the file in place, not extract it. ;)

💬 DisorderlyF, Jan 20th 2024 at 10:45 AM

Apologies for the delay, some IRL things got in the way of me replying. As far as I can tell, the mod works using the method below. However, it was more trouble than initially expected because as far as I can tell, as the 7Zip devs don't package the app for Linux in any official capacity. However, once I was able to sort that, the method you mentioned worked.

💬 BillyGalbreath , Jan 9th 2024 at 5:34 AM

DisorderlyF

You don't extract and recompress the zip. Use a tool like 7zip to open the zip and you can edit the file inside there.

If you extract and recompress you have a much higher potential to mess stuff up (like your pastebin shows it's missing the textures for the ping icons).

  1. install 7zip.
  2. right click the zip and choose "".
  3. right click the modinfo.json and choose "".
  4. make your .
  5. save and close file.
  6. you want 7zip to update the file in the archive.
  7. close the 7zip program, you're done.
💬 DisorderlyF, Jan 8th 2024 at 4:49 AM

Following the instructions to make the mod work without it also installed on the server, then recompressing the extracted contents into a .zip file crashes the game.

The crash log mentions an issue in line 45 of PlayerListHud.cs (also links to what I assume is the project path on your computer)

full crash log here: pastebin.com/H92Funhf

NOTE: initially the .zip file didn't work, log claimed there was no modinfo.json file. This issue was resolved by renaming the .zip file to match the name before it was extracted.

EDIT: I've also confirmed that downgrading to version 1.5.2 does not resolve the issue

💬 BillyGalbreath , Jan 2nd 2024 at 5:24 PM

Arimil

Please read the description fully. I explain how to get it to work with no server side requirement.

💬 Arimil, Dec 30th 2023 at 9:53 AM

I think this should be listed as a server mod, since from my testing this does not function unless installed on the server.

💬 Gnusik2291, Sep 30th 2023 at 9:42 AM

BillyGalbreath

I recommend adding player icons, player ping (e.g. 30 ms) to this mod and making the table background transparent (Tab)

💬 Ruyeex, Sep 23rd 2023 at 1:50 PM

Can you add the image of players.

Also roles as well?

💬 Gnusik2291, Sep 14th 2023 at 2:30 PM

BillyGalbreath

pl.json

{
"keybind-description": "Przytrzymaj, aby wyświetlić listę graczy"
}

💬 Elocrypt, Aug 9th 2023 at 4:00 AM

BillyGalbreath 

Works wonders! (Meant to send this a while ago)
Thank you for the fix!

💬 BillyGalbreath , Aug 6th 2023 at 12:07 PM

Elocrypt

so sorry about that. I had not properly tested it on client side only installs. I fixed the issue in 1.4.0 by properly overriding all the keyboard/mouse input methods for the HUD so I could properly ignore them and not grab them.

Thank you for the report, I would have never known otherwise ^_^

💬 Elocrypt, Aug 5th 2023 at 9:38 PM

BillyGalbreath 

I installed this mod, edited the modinfo.json to be client sided and tested on a server. The mod worked, I pressed TAB and the playerlist came up and worked just fine. Although, I had an issue where I was unable to interact with anything (Opening closing doors, swinging a weapon, picking things up, opening chests, etc,), all I was able to do was move my character around, use chat, look around, move things in my inventory and throw things out of my inventory with Q.

Changing the keybind did not solve the issue. The mod is not on the server itself, only my client. 

After disabling the mod I was able to interact with things again.

💬 DanaCraluminum, Jul 29th 2023 at 8:42 PM

BillyGalbreath

change this

CairoFont font = new() {
    Color = (double[])GuiStyle.DialogDefaultTextColor.Clone(),
    Fontname = GuiStyle.StandardFontName,
    UnscaledFontsize = GuiStyle.SmallFontSize,
    Orientation = EnumTextOrientation.Left
};

to this

if (player.Entitlements?.Count > 0 && GlobalConstants.playerColorByEntitlement.TryGetValue(player.Entitlements[0].Code, out var color))
{
    font = new()
    {
        Color = color,
        Fontname = GuiStyle.StandardFontName,
        UnscaledFontsize = GuiStyle.SmallFontSize,
        Orientation = EnumTextOrientation.Left
    };
}
else
{
    font = new()
    {
        Color = (double[])GuiStyle.DialogDefaultTextColor.Clone(),
        Fontname = GuiStyle.StandardFontName,
        UnscaledFontsize = GuiStyle.SmallFontSize,
        Orientation = EnumTextOrientation.Left
    };
}
 
💬 BillyGalbreath , Jul 29th 2023 at 8:29 PM

DanaCraluminum I highly doubt it, unless the game has the vhtml for that in the IPlayer.PlayerName field automagically.

💬 DanaCraluminum, Jul 29th 2023 at 8:18 PM

Does it show colors? E.g. if player name is Yelow (Supporter) or Green (VS Team)

💬 Rythillian, Jul 29th 2023 at 10:10 AM

simple and highly needed, great mod!

 (edit comment delete)
Основной веб-сайт | Почтовый сервер | FTP сервер | Административная панель | API интерфейс | Content Delivery Network | Статические файлы | Ресурсы сайта | Изображения | Файловое хранилище | Блог | Интернет-магазин | Техническая поддержка | Справочная система | Документация | Форум | Новости | Загрузки | Демонстрация | Тестовая среда | Приложение | Медиа контент | Разработка | Промежуточная среда | Бета версия | Безопасная зона | Вход в систему | Панель управления | Портал | Система управления контентом