Created by Dzeknjak (Jovan Ivanovic)
❤️ Please support my open source work by donating. I'm here to provide general context for complicated procedures for you new developers. ❤️
https://www.buymeacoffee.com/dzeknjak
⭐ This repository if you found it useful!
Simple chat implementation for alt:V to get your server started with some player-to-player interaction.
I cannot stress this enough. Ensure you have NodeJS 13+ or you will have problems.
- NodeJS 13+
- An Existing or New Gamemode
- General Scripting Knowledge
Afterwards, simply add the name of this resource to your server.cfg resource section.
altv-os-chat
Then simply clone this repository into your main server resources folder.
cd resources
git clone https://github.com/jovanivanovic/altv-os-chat
Ensure your package.json includes this property:
"type": "module"There's couple of events to get you started with this resource:
// Notice: these events are mainly serverside unless otherwise stated// Notice: you should probably call this event on player connect or when the player logs in, it's up to you, but it needs to be called for it to work.alt.emit('chat:Init', player, [key]);| Argument | Description |
|---|---|
player |
Instance of a player to initialize the chat for. |
key |
[optional] Keyboard key to trigger the chat input. Default key is T. |
To find a keycode, go to this website: JavaScript Event KeyCodes
alt.emit('chat:Message', recipient, message);| Argument | Description |
|---|---|
recipient |
Either an instance of alt.Player or an array of players to whom you want to send the message to. |
message |
Message you want to send to the players. You can use {FFFFFF} formating to set colors in the message. |
alt.emit('chat:Broadcast', message);| Argument | Description |
|---|---|
message |
Message you want to broadcast to the players. You can use {FFFFFF} formating to set colors in the message. |
// Notice: this event is clientside only.alt.emit('chat:Toggle', [state]);| Argument | Description |
|---|---|
state |
[optional] Sets the visibility state of the chat. If not set, it will show/hide according to the current state of it. |
Scrolling the chat is done simply by pressing Page Up or Page Down keys on your keyboard.
This resource doesn't automatically append messages to the chat window. It is up to you how you want to manipulate the messages, to whom to send them or to parse them as commands.
alt.on('chat:NewMessage', (player, message) => {
// Do your thing here
});| Argument | Description |
|---|---|
player |
alt.Player instance of the player that sent the message. |
message |
The message text that the player sent. |