Th3Essentials

Mods / Th3Essentials

Category: #Utility
Author: Th3Dilli
Side: Server
Created: Sep 11th 2021 at 12:31 PM
Last modified: Oct 22nd at 8:13 PM
Downloads: 3991
Follow Unfollow 30

Important:

If you upgrade from versions befor 1.0.8 and use the starterkit you will have to set it again with /setstarterkit

v1.1.0 and newer only works with 1.16.0-pre7 and newer

for windows to work you have to copy VintageStoryServer.exe.config from th3essentials.zip next to VintagestoryServer.exe (Could not load file or assembly issue)

You may see this message poping up in your logs, but dont worry this is just the bot reconnecting to the discord api and can happen daily. I may suppress this log in the future.

[Server Warning] [Discord] Gateway     Discord.WebSocket.GatewayReconnectException: Server requested a reconnect
ў System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
ў Discord.ConnectionManager.<>c__DisplayClass29_0.<b__0>d.MoveNext()

For help, discussion, suggestions, translations and polls on new features join the Discord Server

Features:

Discord integration (send messages from game to discord and back, Ingame-GenralChat to one specific Discord-channel, customizable color) [on/off]
- restart / death / join / temporal messages are send to discord
- discord slashcommands for restart-time , ingame time and online players
- display playercount in the activity of the bot
- display discord mentions (user/channel/role) correctly
Shutdown - Set a time when the server should shutdown (starting of the server needs to be handled externally!!!) [on/off]
- additionally warns the players about the restart x min before restart
Add homepoints to teleport to, limited by a configurable cooldown [on/off]
starterkit - add a starterkit to be used only once (can be reset) [on/off]
- starterkit can be set ingame by an admin
/spawn command to teleport to spawn also respecting cooldown [on/off]
/back command to teleport back to previous postion (/home or death) [on/off]
Announcements messages (a list of messages that are send in an configurable interval) [on/off]
/msg playername - to send private messages ingame (customizable color) [on/off]
/r message - to send private messages ingame to last messaging player (enabled if /msg is on)
Serer Metrics, logs metrics (/stats and more) to InfluxDB and visualize it with influxDB or grafana
/requesthelp [message] , pings the help role (HelpRoleID in config) in Discord with the message
show role names ingame and discord if enabled (admin, moderator) - see config ShowRole
/admin ingame/discord command , lists all roles specified by "AdminRoles" [on/off]
reward system that allows you to add a text/icon to ingame chat if that player has a certain role in discord (Patreon)
announce a message from discord to ingame

Discord Slashcommands:

/players - Get a list of online players (optional show the ping)
/date - Get the current ingame date and time
/restarttime - Show time until next restart
/setchannel - Set the channel to send to/from ingame chat [Admin]
/modifypermissions - add/remove/clear additional roles to use moderation commands [Admin]
/whitelist - Change the whitelist status of a player (also the time duration is customizable, default 50 years as with the ingame command) [Admin or Configured Role]
/allowcharselonce - Allows the player to re-select their class after doing so already [Admin or Configured Role]
/shutdown - Will shutdown the server (if configured server will restart ) [Admin or Configured Role]
/admins - lists all admins speciefied by "AdminRoles" in Th3Condfig.json
/serverinfo - prints game and mod versions
/stats Print the output of the ingame /stats command [Admin or Configured Role]
/auth - start to link discord and ingame account for the reward system
/announce - announce a message from discord to ingame chat [Admin or Configured Role]

For install instructions see the readme at the repository

Version	For Game version	Downloads	Release date	Changelog	Download
v2.1.0 v2.1.0 add automatic backup feature (lock server, kick players, backup, restart) fix reply command to reply to last received message separate discord reconnect warnings to debug log	#v1.17.9	100	Oct 22nd at 8:13 PM	Show	Th3Essentials_2.1.0.zip
v2.0.0 v2.0.0 - update to v2 since we now requiere a game version of atleast 1.17.0-pre.1 - add warp ingame command (admins can set up warp locations) - update logticks metric collector for new 1.17 - fixed /serverinfo command if many mods are installed	#v1.17.0-pre #v1.17.0 #v1.17.3 #v1.17.4	167	Sep 1st at 9:59 AM	Show	Th3Essentials_2.0.0.zip
v1.1.9 v1.1.9 - fixed problems related to reward system - fixed setchannel not saving to config - fixed mention @ everyone from ingame - add announce discord command - updated discord bot lib and docker images	#v1.16.5	192	May 4th at 9:33 PM	Show	Th3Essentials_1.1.9.zip
v1.1.8 v1.1.8 - fix bot permission if rewards are not used - improved rewards messages	#v1.16.5	123	Apr 18th at 11:03 AM	Show	Th3Essentials_1.1.8.zip
v1.1.7 v1.1.7 - added basic rewards system (can map discord roles to ingame role and display it in chat) - fixed a bug where when "ModerationRoles" : null , was set the server would crash if some one without admin permissions would use a admin or mod slashcommand in discord	#v1.16.5	89	Apr 16th at 8:10 AM	Show	Th3Essentials_1.1.7.zip
v1.1.6 v1.1.6 fixed starterkit for usage with other mods items/blocks fixed player count (-1) add fr,it,ru translations thx to the generous contributors <3 fixed reset starterkit-all command	#v1.16.1 #v1.16.3	171	Feb 24th at 10:13 AM	Show	Th3Essentials_1.1.6.zip
v1.1.5 v1.1.5 fixed modify roles not working added multiple server support for grafana possible shutdown hang error fix (was not able to reproduce) include fatal log level in grafana log improved player count accuracy only save config when modified fix whitelist command always success response fix temporal msg on restart even if turned off (edge case) add new slashcommands (stats, admins [works also ingame], serverinfo)	#v1.16.1 #v1.16.2-rc.1	192	Feb 1st at 5:44 PM	Show	Th3Essentials_1.1.5.zip
v1.1.4 v1.1.4 fix temporal messages if server restarts when storm is on fix nullpointer if logticks is on but influxdb is not used add config option to customize how roles are shown ingame add influxdb playtime metric	#v1.16.0 #v1.16.1	157	Jan 23rd at 10:20 PM	Show	Th3Essentials_1.1.4.zip
v1.1.3 v1.1.3 fixes multiple nullpointer exceptions (PlayerDeath, InfluxDB, Dispose) also fixes hanging on shutdown seperated overload messages in influxdb improved performance for getting temporal messages > copy the new VintageStoryServer.exe.config next to VintageStoryServer.exe	#v1.16.0 #v1.16.1-rc.3	139	Jan 21st at 7:33 PM	Show	Th3Essentials_1.1.3.zip
v1.1.2 v1.1.2 better workaround for windows (assembly load issues) improved error handling for influxdb added ingame command /requesthelp to send a notifiaction for a spesific role to discord see DiscordConfig -> HelpRoleID added to the /players discord command the additional arguments ping to show player ping time added ability to show player roles ingame and discord roles can be configured in serverconfig.json, system is enabled in Th3Config.json included debug symbols	#v1.16.0 #v1.16.1-rc.2	155	Jan 16th at 6:34 PM	Show	Th3Essentials_1.1.2.zip
v1.1.1 v1.1.1 updated discord version	#v1.16.0	188	Jan 10th at 7:50 PM	Show	Th3Essentials_1.1.1.zip
v1.1.0 v1.1.0 Added logging to influxdb see repo readme for install instructions and config only works with 1.16.0-pre.7 and up	#v1.16.0-pre	188	Dec 15th 2021 at 10:31 PM	Show	Th3Essentials_1.1.0.zip
v1.0.9 v1.0.9 fixed food spawning in rotted (since the timer was saved with the item when i intoduced the attributes to fix lanterns)	#v1.15.9	219	Nov 26th 2021 at 8:09 AM	Show	Th3Essentials_1.0.9.zip
v1.0.8 v1.0.8 Fix starterkitsystem finally Added /r command to reply to last message (private ingame messages)	#v1.15.7	206	Oct 25th 2021 at 11:04 PM	Show	Th3Essentials_1.0.8.zip
v1.0.7 v1.0.7 Fixed broken starterkit items (eg lanterns)	#v1.15.7	180	Oct 25th 2021 at 8:11 PM	Show	Th3Essentials_1.0.7.zip
v1.0.6 v1.0.6 added new shutdown command (it will restart the server if configured) renamed /restart to /restarttime to remove confusion	#v1.15.5 #v1.15.6 #v1.15.7-rc.1	197	Oct 8th 2021 at 7:38 PM	Show	Th3Essentials_1.0.6.zip
v1.0.5 v1.0.5 fixed whitelist slashcommand not working if player was not on server yet	#v1.15.5 #v1.15.6	189	Oct 7th 2021 at 6:11 PM	Show	Th3Essentials_1.0.5.zip
v1.0.4 v1.0.4 Added configurable permissions for the whitelist and allowcharselonce slashcommands Added player count on join/leave messages (thx to Sps)	#v1.15.5 #v1.15.6	209	Sep 26th 2021 at 5:34 PM	Show	Th3Essentials_1.0.4.zip
v1.0.3 v1.0.3 Fixed creation of slashcommands Updated guid with permissions	#v1.15.5	236	Sep 20th 2021 at 9:08 AM	Show	Th3Essentials_1.0.3.zip
v1.0.2 v1.0.2 add /whitelist and /allowcharselonce discord commands add temporal storm messages to discord to get the new slashcommands run `!setupth3essentials` in the linked chat channel	#v1.15.5	229	Sep 16th 2021 at 10:23 PM	Show	Th3Essentials_1.0.2.zip
v1.0.1 v1.0.1 Add the option to show discord command repsonse only to the user that used the command Fixed messages are only send from GeneralChat (also includes Info log) to discord and not every chat channel like private groups and such	#v1.15.5	217	Sep 16th 2021 at 5:44 AM	Show	Th3Essentials_1.0.1.zip
v1.0.0 v1.0.0 initial release	#v1.15.5	233	Sep 14th 2021 at 6:31 PM	Show	Th3Essentials_1.0.0.zip

30 Comments (oldest first | newest first)

💬 Nicodemus, Sep 2nd at 9:42 AM

Hi, I heard of some recent changes with Discord and now my bot is down... Any tips to correct that?

Edit : nvm it works now! Sorry!

💬 CreativeRealms, Sep 1st at 3:55 PM

Th3Dilli works now. Thanks!

💬 Th3Dilli, Sep 1st at 1:52 PM

CreativeRealms

try again pls with the newest version that is build for 1.17

💬 CreativeRealms, Aug 30th at 9:16 PM

The bot is disconnecting on startup using v1.17.0-rc.8. v1.17.0-rc.7 worked fine and I made no changes to the server between updating.

30.8.2022 21:10:42 [Warning] [Discord] Gateway System.Threading.Tasks.TaskCanceledException: A task was canceled.
at Discord.ConnectionManager+<>c__DisplayClass29_0.<StartAsync>b__0 () [0x00147] in <24edb5a3ce294c56aacb6f44b63c9d65>:0

💬 Kara, May 23rd at 5:59 AM

so, with starterkit is their a way to create more then one kit? like not just a starter kit?

💬 Th3Dilli, May 4th at 7:46 PM

RogueRaiden
with the "AdminRoles" you can add any role to display a tag see the repository readme for more information

💬 RogueRaiden, Apr 18th at 5:48 PM

Only admin and moderator roles will show a tag?

Could any role be set to show a tag?

💬 Th3Dilli, Apr 18th at 11:04 AM

thank you for pointing out bluelightning32,

mod has been updated,
if the rewards are not used it should work fine again without "SERVER MEMBERS INTENT", and if you wanna use it i added the information to the readme

💬 bluelightning32, Apr 16th at 10:47 PM

After upgrading to v1.1.7, this mod stopped working. I had to go to "Bot" on the discord developer portal and check "SERVER MEMBERS INTENT" for the mod to start working again. I couldn't find a reference to this step in the install guide.

💬 YourCreator, Feb 10th at 5:39 PM

@Th3Dilli yeah, i checked it after posting, working as should.
Can you add warps? it will be perfect

💬 Th3Dilli, Feb 9th at 6:25 PM

YourCreator

thank you for the russion translation ;)

for the issue you are having check out the solution right below the "Important:" headline here

💬 YourCreator, Feb 9th at 1:43 PM

Russian translate.json

💬 YourCreator, Feb 9th at 10:14 AM

[Error] [Th3Essentials] Exception thrown when attempting to retrieve all types of the assembly Discord.Net.Core, Version=3.2.0.0, Culture=neutral, PublicKeyToken=null: System.Reflection.ReflectionTypeLoadException: Не удается загрузить один или более запрошенных типов. Обратитесь к свойству LoaderExceptions для получения дополнительных сведений.
в System.Reflection.RuntimeModule.GetTypes(RuntimeModule module)
в System.Reflection.Assembly.GetTypes()
в Vintagestory.Common.ModContainer.GetModSystems(Assembly assembly), InnerException: . Will ignore asssembly. Loader exceptions:

💬 Aledark, Feb 1st at 11:49 PM

Such a good mod author. I've worked very closely with Th3dilly who became a friend so i'm biased but i'll say that i love this mod as an admin and the community too! ★★★★!

💬 WickedSchnitzel, Jan 29th at 8:31 AM

Getting "The temporal storm seems to be waning" every time on server restart, even though temp stability and rifts are disabled on the server.

💬 Th3Dilli, Jan 24th at 7:55 AM

WickedSchnitzel

take a look at the Important section here (i updated it to stand more out), if you got still problems feel free to join the discord linked above

💬 WickedSchnitzel, Jan 24th at 7:32 AM

[Error] [Th3Essentials] System.IO.FileNotFoundException: Could not load file or assembly 'System.Threading.Tasks.Extensions, Version=4.2.0.0, Culture=neutral, PublicKeyToken=-removed-' or one of its dependencies. The system cannot find the file specified.
File name: 'System.Threading.Tasks.Extensions, Version=4.2.0.0, Culture=neutral, PublicKeyToken= -removed-'

[Error] [Th3Essentials] Exception thrown when attempting to retrieve all types of the assembly Discord.Net.Rest, Version=3.2.0.0, Culture=neutral, PublicKeyToken=null: System.Reflection.ReflectionTypeLoadException: Unable to load one or more of the requested types. Retrieve the LoaderExceptions property for more information.
at System.Reflection.RuntimeModule.GetTypes(RuntimeModule module)
at System.Reflection.Assembly.GetTypes()
at Vintagestory.Common.ModContainer.GetModSystems(Assembly assembly), InnerException: . Will ignore asssembly. Loader exceptions:
24.1.2022 08:27:57 [Error] [Th3Essentials] System.IO.FileNotFoundException: Could not load file or assembly 'System.Threading.Tasks.Extensions, Version=4.2.0.0, Culture=neutral, PublicKeyToken=-removed-' or one of its dependencies. The system cannot find the file specified.
File name: 'System.Threading.Tasks.Extensions, Version=4.2.0.0, Culture=neutral, PublicKeyToken=-removed-' Th3Dilli

💬 Th3Dilli, Jan 9th at 8:27 PM

StewBag

seems to work fine for me, any errors in the debug log?

you can contact me on vintagestory discord: Th3Dilli

RogueRaiden

this atm not supported, i may add it at somepoint but cant promise when

the way i have dealt with such things is, the script that restarts the server once shutdown also does a copy of the worldfile and then make zip out of it while the server starts already since making a zip from a 30GB file takes awhile

💬 StewBag, Jan 9th at 5:38 PM

RC8 has broken all functionality of 1.1.0

💬 RogueRaiden, Dec 21st 2021 at 5:33 AM

Is there anyway to have the backup feature also zip up the backup file and the logs folder?

At the very least, a separate feature on a seperate timer to zip up the logs folder?

💬 Th3Dilli, Nov 26th 2021 at 8:15 AM

Vinter_Nacht

right now this is not configurable ill be looking into it so ppl can easily set it up and keep using the current system if that is what they need without additional configuration needed

WickedSchnitzel

the food spawning in as rot should be fixed now, just use /setstarterkit again

💬 Vinter_Nacht, Nov 17th 2021 at 4:23 PM

Is there a way to have different information broadcast to different channels?
I want login/logout information to go to one channel, announcements to go to another channel, and chat/shutdown announcements to go to a different channel.

💬 WickedSchnitzel, Nov 13th 2021 at 4:54 PM

{
"Itemclass": 1,
"Code": "bread-rye-perfect",
"Stacksize": 3,
"Attributes": "Bg90cmFuc2l0aW9uc3RhdGUDEWNyZWF0ZWRUb3RhbEhvdXJz8/wa5w6ZsUADFWxhc3RVcGRhdGVkVG90YWxIb3Vyc3uCdbqjmbFADApmcmVzaEhvdXJzAQAAAAAAQEMMD3RyYW5zaXRpb25Ib3VycwEAAAAAABBCDBF0cmFuc2l0aW9uZWRIb3VycwEAAABb05Q+AAA="
},

My players receive rot instead of bread in their starterkit. I have noticed that other items have the "AA==" only. Should i change that? Th3Dilli

💬 RogueRaiden, Nov 8th 2021 at 6:24 AM

Ive tried like 4 times now following the install instructions and the bot never shows online in Discord or responds to commands. lol

Edit: Make sure your server is OFFLINE when you change your configs!!!

💬 Th3Dilli, Oct 29th 2021 at 8:35 AM

oh yeah did not think about that sorry

💬 WickedSchnitzel, Oct 28th 2021 at 8:31 PM

New players are not able to get their /starterkit anymore since i have updated to 1.0.8. Do i have to re-add the kit after every update? It's still in the config though. - update: ok it's working again. Had to set it once again with /setstarterkit even though all the items where still in the config file.

💬 Th3Dilli, Oct 8th 2021 at 7:31 PM

WickedSchnitzel

i did some testing and it seems there is also a problem with the base game and its /giveblock command on lanterns, i will see if i can do anything about it

to be save do not use any lanterns in starterkits since when you place such a lantern it crashes your game and makes that chunk unplayable

💬 WickedSchnitzel, Oct 7th 2021 at 9:18 PM

No, i mean if people use /starterkit. If theres a lantern included in that kit. Th3Dilli

💬 Th3Dilli, Oct 7th 2021 at 6:21 PM

WickedSchnitzel

i guess you mean the Th3Expansion mod, what lanterns do you mean exactly?

💬 WickedSchnitzel, Sep 30th 2021 at 1:38 AM

Lanterns do not have a texture if spawned into the inventory as no material was defined. May apply to some other items as well. Th3Dilli

(edit comment delete)