Skip to main content

Installation

Basic installation instructions for Wasabi Chat (wasabi_chat).


danger

The resource must be named wasabi_chat to operate correctly.

info

Not an English server? Set language in config/shared/config.lua to your language.

Supported Languages: en, cn, cs, da, de, es, fr, hi, it, jp, ko, nl, pl, pt, and tw

1. Install and start dependencies​

Ensure all dependencies are installed, current, and configured.

2. Remove the stock chat​

Remove ensure chat from your server.cfg (or remove the chat resource). Wasabi Chat takes its place with provide 'chat', so resources that depend on chat still start.

warning

If the stock chat resource is still running, other scripts may show No such export ... in resource chat. Remove ensure chat and restart the server.

3. Add inventory items and images​

Wrist Link item mode is on by default (wristLink.item.enabled = true). The resource includes item definitions and images in _invItems.

  1. Add the appropriate item definition from _invItems/data.lua to your inventory. It includes entries for ox_inventory (also used for wasabi_inventory), qb-inventory, codem-inventory, jaksam_inventory, and tgiann-inventory.
  2. Copy _invItems/images/wristlink.png into your inventory image directory.
  3. Keep the item non-stackable (stack = false / unique = true). Each watch remembers its signed-in account. tgiann-inventory also needs hasMetadata = true.

Example for ox_inventory/data/items.lua:

["wristlink"] = {
label = 'Wrist Link',
weight = 25,
stack = false,
close = true,
consume = 0,
description = 'A wrist-mounted private messaging device.',
server = { export = 'wasabi_chat.wristlink' },
},

Wasabi Chat registers the item as usable itself. To skip the item, set wristLink.item.enabled = false and players open Wrist Link with /wristlink.

4. Review all three configuration files​

  • Shared: config/shared/config.lua
  • Client: config/client/config.lua
  • Server: config/server/config.lua

At minimum, review your channels, staff groups, job announcements, Wrist Link settings, allowed image hosts, and Discord logging. See Configurations.

info

Setting debug = true in the shared configuration helps during initial set-up.

5. Start the resource​

Place wasabi_chat in your resources directory and start it after the framework, Ox Lib, OxMySQL, and your inventory.

ensure ox_lib
ensure oxmysql
# ensure your framework and inventory first
ensure wasabi_chat

The resource creates its required database tables automatically on startup. Its database user therefore needs CREATE permission and may need ALTER permission when a shipped schema migration adds columns. There is nothing to import.

  • wasabi_chat_direct_messages, wasabi_chat_direct_unread: Wrist Link DMs and unread counts
  • wasabi_chat_relationships, wasabi_chat_blocks, wasabi_chat_profiles: friends, requests, blocks, and profiles
  • wasabi_chat_mutes: saved mutes
  • wasabi_chat_accounts: Wrist Link accounts (item mode only)

6. Restart and enjoy!​

Restart the server and enjoy.

note

The release package includes the built UI in ui/build/. Only if you build the UI from source, run npm ci and npm run build inside the ui folder.