Skip to content

UTChat for Server Operators

Alec Sears edited this page Jan 23, 2014 · 1 revision

UTChat -- UText-based Chat Replacement

Simple Chat Replacement

UTChat is very simple to users -- even though the code behind it may not be. Simply installing it will set all your modules to use it.

Installation

UTChat is currently packaged in utlib_full_.zip during the alpha stage.

You can download the appropriate package for your server's operating system here: Windows Linux


Windows Installation


Automatic

  • Extract the zip to your server's scripts folder, you should see scripts\UTLib\ and three .bat files in the scripts folder.
  • Run UTLib_install_integrator.bat This will automatically link the utlIntegrator.lua file to all modules and allow them to use UTChat
  • If the server is running, reloadall

Report any errors during installation or module loading to the Issues page

Manual

  • Copy the file scripts\UTLib\shared\utlIntegrator.lua
  • Paste into each module like so: scripts<module>\shared\utlIntegrator.lua (create the shared folder if it does not exist)
  • If the server is running, reloadall

Linux Installation


Automatic

  • Extract the zip to your server's scripts folder, you should see ./scripts/UTLib/ and three .bsh files in the scripts folder. These are Bash scripts -- I do not believe they are compatible with sh as they use bash specific format. Make sure you are in a Bash environment before running them.
  • You may need to chmod +x UTLib*.bsh
  • Run ./UTLib_install_integrator.bsh This will automatically hardlink the utlIntegrator.lua file to all modules and allow them to use UTChat
  • If the server is running, reloadall

Report any errors during installation or module loading to the Issues page

Manual

  • Distribute ./scripts/UTLib/shared/utlIntegrator.lua to each module using one of two methods:
  • Copy into each module: cp ./scripts/UTLib/shared/utlIntegrator ./scripts//shared/utlIntegrator.lua (create the shared folder if it does not exist)
  • Hardlink into each module: ln ./scripts/UTLib/shared/utlIntegrator ./scripts//shared/utlIntegrator.lua (create the shared folder if it does not exist)
  • If the server is running, reloadall

Updating and Uninstallation


If updating utlIntegrator.lua is necessary, you can run your respective UTLib_update_integrator script. This will remove and distribute the new utlIntegrator.lua found in UTLib.

If uninstalling from all modules, you can run your respective UTLib_uninstall_integrator script. This will remove the file from all modules except UTLib.

If you manually copied utlIntegrator.lua, either of these scripts should work assuming the file is named properly in the shared folder of each module.

You may also selectively copy and remove utlIntegrator in any module as you desire. The scripts are just a way to install to all or uninstall from all conveniently.

UTChat and ZED 2.0


UTChat and ZED are currently not compatible -- only one will control the chat system.

If ZED has control:

  • UTChat will do nothing

if UTChat has control:

  • ZED's commands will continue to try and write to it's own chat box, possibly overlapping UTChat's.

Which one has control is determined by which module loads last, almost indeterminable.