Mods / Typing Indicator
Issue tracker
Author: Fatigue
Side: Both
Created: Jun 25th at 4:55 AM
Last modified: Jul 7th at 7:03 AM
Downloads: 4108
Follow Unfollow 24
Latest file for v1.19.8:
TypingIndicator.zip
1-click install
Server / Singleplayer compatible. Must be installed on both client and server for it to successfully function.
Server owners, when you update this mod it will replace your configuration.
1. Go to VintagestoryData/ModConfig/typing_indicator/
2. Adjust VintagestoryData/ModConfig/typing_indicator/config.json with the localization text each update.
2.1. Your old configuration files have been moved to VintagestoryData/ModConfig/typing_indicator/out_of_date_configs/config_(version).json. You can copy/paste what's changed; this is just a safety thing in case the server packets change in the future. In most cases unless otherwise specified, you can basically copy paste everything above READONLY_CreatedWithTypingIndicatorVersion to the new configuration.
Should fix https://github.com/FatigueDev/typing_indicator/issues/2, which is a null reference exception when the display text is null in the renderer. Prevents players with rough connections from crashing, instead temporarily displaying the default english localization before the server finishes sending it's preferred configuration to be displayed.
Server Owners / Singleplayers:
When the game is run, it spits out a new configuration file containing the following defaults:{
"Localizations": {
"en": "Typing..."
},
"Timeout": 5.0,
"MaxRange": 50,
"READONLY_CreatedWithTypingIndicatorVersion": "1.1.0"
}
Localizations can be appended to and given custom text. The default is "en": "Typing...", but once the configuration is created it can be changed while the server is running. Players re-log, they get the updated contents of this config applied to their TypingIndicator.
Timeout is how long a player can not type before they stop displaying their indicator in seconds.
MaxRange is how far players can see each other's typing indicators (NOT in blocks, it's a magic distance number. Please tweak this until you're happy with how far away it is displayed.
READONLY_CreatedWithTypingIndicatorVersion is a flag for creating configs. If the mod updates, we'll move your old config to ModConfig/typing_indicator/out_of_date_configs/ so you can copy and paste your old configuration settings to potentially a new configuration format. I don't think it'll be updated often, but if and when it is you'll need to keep this in mind.
| Version | For Game version | Downloads | Release date | Changelog | Download | 1-click mod install* |
|---|---|---|---|---|---|---|
| v1.1.2 | 3112 | Jul 7th at 7:03 AM | Show | TypingIndicator.zip | Install now | |
| v1.1.1 | 748 | Jun 27th at 10:20 AM | Show | TypingIndicator.zip | Install now | |
| v1.1.0 | 69 | Jun 27th at 4:53 AM | Show | TypingIndicator.zip | Install now | |
| v1.0.0 | 179 | Jun 25th at 4:58 AM | Show | TypingIndicator.zip | Install now |
It looks like the server config is placed in data/data/ModConfig instead of data/ModConfig. Is this expected behavior?
Updated to version 1.1.2 (Server owners, update your configurations);
Should fix https://github.com/FatigueDev/typing_indicator/issues/2, which is a null reference exception when the display text is null in the renderer. Prevents players with rough connections from crashing, instead temporarily displaying the default english localization before the server finishes sending it's preferred configuration to be displayed.
Updated to version 1.1.1;
Hotfix for singleplayer, should hopefully fix https://github.com/FatigueDev/typing_indicator/issues/1 reported by WickedSchnitzel
Updated to version 1.1.0;
Added configuration that's given to clients.
Localization; now you can set the typing indicator of all your players to "Grundle bo-bundle..." or whatever you like. You can add support for a new language by adding the language code as it's key and giving it a value. If it doesn't exist, it defaults to English. PLEASE, if you are adding a new language that is simply "Typing..." but in a Vintage Story supported language, make a pull request with the addition to this file on the Typing Indicator Github.
Added typing timeout which, if you type type type but stop for a length of time defined in your config (default 5 seconds) you'll stop typing.
Added max display distance which is a magic number. I'm not keen on getting into the render code but it's configurable.
All configurable options are sent when a player joins, so you can change the values in the config and make all the players rejoin to have them show the newest values in the config.
That is a nice mod! Think if the text can be changed, I'd change it to "Clears throat ..." 😀
gg
I have lots of things planned for config, but after spending a couple long nights on it I'm gonna take a bit to chill and turn my brain off.
Features planned:
- Timer that counts how long the text hasn't changed. If it exceeds the max (config), stop IsTyping.
- Localization file loaded serverside which can display the text in whatever language you choose (config). It'd also let you change the displayed text.
- Settable distance on how far away the Typing indicator can be seen (config).
Other possible features could include sending a placeholder message when someone starts typing into the client's chat. Like..
'(PlayerName) is typing...'
But when they stop typing (either by sending the message or by timing out / losing chat focus), that is removed from the text chat.
If I did add this functionality, it'd probably be opt in on the client. Could use thoughts.
Suggestion: Add a config to let admins decide what will be displayed. For example, i would prefer "Thinking.."
Tested it on localhost dedicated, works great! Will report back with results from online play soon.
I do have one suggestion: configurable timeout, so the indicator goes away if you still have the chatbar focused but have not entered any characters for n seconds. For those players who afk in the middle of a sentence lol
At any rate, thanks a bunch for putting this out!
Thank you so much for even attempting to make this!
Iphour Cheers, mate. Hope it's stable. Tested on my local server with some people, so fingers crossed. If you have any issues, post here or on the issue tracker. Enjoy!
I love you for this