AWS Chat

A roleplay chat interface with local actions, job channels, announcements and configurable identity presentation.

Installation

Requirements

• QBCore or ESX. Qbox requires a working qb-core compatibility bridge for this build.

Startup order

This example selects one framework and target. Use the resources matching your configuration and start dependencies first.

ensure qb-core
ensure aws-chat

Setup steps

1. Disable or remove the competing stock/custom chat interface so both do not process the same input.
2. The prebuilt ui/build/index.html is included; no UI build step is needed for installation.
3. Review staff checks and job names in server/commands.lua before enabling restricted channels. No package SQL installer is required.

Gameplay and usage

1. Use T to open chat; test /me, /do, /ooc and /tweet.
2. Test /police, /ems and /announce with authorized and unauthorized accounts. Permissions are implemented in server/commands.lua.

Configuration

• shared/config.lua: Config.ShowChatKey defaults to T.
• Config.CustomNameColor, Config.CustomNameTag and Config.AnonymousWithMask control identity presentation.
• Config.OOCMessageWithoutCommand and Config.OOCMessageGlobal control OOC behavior.
• Config.YellowPageFee, Config.SendImage, Config.DarkChat, Config.TypeColors and Config.Locales configure channels and presentation.

Exports and integrations

No public callable export is declared with exports() in these source files. Use the documented commands or configuration; internal network events are not a trusted integration API.

Troubleshooting

• Duplicate messages usually indicate another chat resource is still handling the same events.

• If player/job data is missing, start the core first and review shared/utils.lua and shared/bridge.lua.

• Include the package version, framework and exact server/F8 error when requesting support. Remove private tokens and player data.

Package reference

Database files

No standalone SQL file is included. Check the installation steps above for tables created by server code.

Configuration reference

• aws-chat/shared/config.lua: ShowChatKey, YellowPageFee, EnableEmojiMenu, OOCMessageWithoutCommand, OOCMessageGlobal, CustomNameColor, CustomNameTag, JobInfoCommand, MoneyInfoCommand, AnonymousWithMask, DarkChat, SendImage, HotBarSuggestions, DefaultSuggestions, TypeColors, Locales, RPCoordsX, RPCoordsY

Frequently asked questions

Does this need Keymaster or an escrow key?

The Lua sources in this delivery package were readable in the static audit. No /assetpacks requirement is added by this package. Required framework, inventory and map resources still need to be installed separately.

Can I change the folder or database table names?

Keep the supplied folder names. Historical event, SQL and KVP identifiers are retained to protect existing integrations and saved data. Renaming a table or event requires a separate migration.

Why is an interface or item missing?

Check the startup order, selected framework/target adapter, inventory item definitions and the server/F8 console. The package does not install an entire framework or inventory for you.

Has this been tested on my server?

ZIP integrity, source readability, script syntax and manifest references were checked locally. Multiplayer gameplay, your framework version and integrations require a FiveM server acceptance test before a public release.