Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stuyk/altv-os-global-textlabels
Global Text Labels with a simple interface to display information in-game.
https://github.com/stuyk/altv-os-global-textlabels
altv fivem ragemp
Last synced: 18 days ago
JSON representation
Global Text Labels with a simple interface to display information in-game.
- Host: GitHub
- URL: https://github.com/stuyk/altv-os-global-textlabels
- Owner: Stuyk
- License: gpl-3.0
- Created: 2020-07-22T00:11:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-11T12:48:14.000Z (over 3 years ago)
- Last Synced: 2024-05-01T16:36:19.642Z (8 months ago)
- Topics: altv, fivem, ragemp
- Language: JavaScript
- Homepage: https://stuyk.com/
- Size: 29.3 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Open Source - Global Text Labels - alt:V
[❤️ Become a Sponsor of my Open Source Work](https://github.com/sponsors/Stuyk/)
[⌨️ Learn how to script for alt:V](https://altv.stuyk.com/)
[💡 Need a Roleplay Script? Try Athena!](https://gtavathena.com/)
⭐ This repository if you found it useful!
---
# Description
Easily create global text labels with custom color, font, scale, and distance. Text Labels are automatically synchronized when a player joins the server.
Keep in mind that these are globally seen by all players.
## Installing Dependencies / Installation
**I cannot stress this enough. Ensure you have NodeJS 13+ or you will have problems.**
- [NodeJS 13+](https://nodejs.org/en/download/current/)
- An Existing or New Gamemode
- General Scripting Knowledge
After simply add the name of this resource to your `server.cfg` resource section.
`altv-os-global-textlabels`
Then simply clone this repository into your main server resources folder.
```
cd resources
git clone https://github.com/Stuyk/altv-os-global-textlabels
```
Ensure your `package.json` includes this property:
```json
"type": "module"
```
## Creating a Text Label
Uses the event called `'textLabel:Create'`
| Parameter | Description |
| ------------ | ------------------------------------------ |
| `identifier` | Unique string to associate with the label. |
| `text` | The text to display in the label. |
| `position` | A Vector3 or `position` to place it. |
| `distance` | Distance before it draws for a player. |
| `fontType` | 0,1,2,4, and 7 |
| `scale` | Size of the text. Recommend: 0.4 |
| `red` | 0-255 |
| `green` | 0-255 |
| `blue` | 0-255 |
| `alpha` | 0-255 |
### Example
```js
alt.emit(
'textLabel:Create',
'label2',
'Testing',
{
x: -1303.6351318359375,
y: 153.87692260742188,
z: 58.160400390625
},
5,
2,
0.4,
255,
255,
255,
100
);
```
## Destroy a Text Label
If you ever need to destroy the label you have created during the runtime you can simply call `textLabel:Destroy`.
| Parameter | Description |
| ------------ | ------------------------------------------ |
| `identifier` | Unique string to associate with the label. |
### Example
```js
alt.emit('textLabel:Destroy', 'label2');
```
# Other alt:V Open Source Resources
- [Authentication by Stuyk](https://github.com/Stuyk/altv-os-auth)
- [Discord Authentication by Stuyk](https://github.com/Stuyk/altv-discord-auth)
- [Global Blip Manager by Dzeknjak](https://github.com/jovanivanovic/altv-os-global-blip-manager)
- [Global Marker Manager by Dzeknjak](https://github.com/jovanivanovic/altv-os-global-marker-manager)
- [Chat by Dzeknjak](https://github.com/jovanivanovic/altv-os-chat)
- [Entity Sync for JS by LeonMrBonnie](https://github.com/LeonMrBonnie/altv-os-js-entitysync)