> For the complete documentation index, see [llms.txt](https://yourmaps.gitbook.io/yourmaps-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://yourmaps.gitbook.io/yourmaps-docs/yourscripts/yourmaps-flagscript.md).

# YourMAPS FlagScript

**YourMAPS FlagScript** is a free open-source RedM flag system created by YourMAPS.

It was created to fill the gap for a simple and configurable flag system that allows players to equip, carry, drop, and pick up flags as in-game items.

The script supports item-based framework integration, animations, prompts, object attachments, keybinds, and cleanup logic.

<figure><img src="https://private-user-images.githubusercontent.com/79672264/430535340-df41b58d-4426-4485-aaa7-026e5259950c.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzgyNTY3ODMsIm5iZiI6MTc3ODI1NjQ4MywicGF0aCI6Ii83OTY3MjI2NC80MzA1MzUzNDAtZGY0MWI1OGQtNDQyNi00NDg1LWFhYTctMDI2ZTUyNTk5NTBjLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA1MDglMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwNTA4VDE2MDgwM1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWU3Nzc5OGQ0Nzk4MDc5NmRjNjkyYWYwOTc2MTQyZjI1YmE2MTcyNzcxNThmM2MxZDY5NjM1NTJmOTRhNTkxOTEmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JnJlc3BvbnNlLWNvbnRlbnQtdHlwZT1pbWFnZSUyRnBuZyJ9.N-0lLbvC0IAdtY5QOj8--e19TasgtEYuucrFJXg826I" alt=""><figcaption></figcaption></figure>

### GitHub Link

[Download YourMAPS FlagScript](https://github.com/zetafe1/yourmaps_flagscript/tree/main)

### What It Does

YourMAPS FlagScript allows players to use flags in a more immersive way.

Players can:

* Equip and carry flags in hand
* Drop flags on the ground
* Pick flags back up
* Use configurable keybinds
* Use flags through item-based systems
* Use animations and prop attachments
* Configure the script depending on the server needs

### Supported Frameworks

According to the GitHub README, the script supports:

* REDEMRP
* VORP
* Other frameworks / standalone-style setups&#x20;

<figure><img src="https://private-user-images.githubusercontent.com/79672264/430535695-31dde33b-d76a-48bb-be80-94f0de7b60df.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzgyNTY3ODMsIm5iZiI6MTc3ODI1NjQ4MywicGF0aCI6Ii83OTY3MjI2NC80MzA1MzU2OTUtMzFkZGUzM2ItZDc2YS00OGJiLWJlODAtOTRmMGRlN2I2MGRmLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA1MDglMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwNTA4VDE2MDgwM1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWI3NTFmOTNhNDkyZjgyY2UyNDJjMzUzMGE3NDZjYzk5OTg4MDIyMzJkMzU2NTllNGE0MzE3MmRmYWJjOWQwYzImWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JnJlc3BvbnNlLWNvbnRlbnQtdHlwZT1pbWFnZSUyRnBuZyJ9.thMrlAo4mJ3GcPW1StPUcGLCeq84XU_SXStqZexXfFo" alt=""><figcaption></figcaption></figure>

### Included by Default

The free release includes 4 YFT flags:

* Mexico
* Canada
* LGBTQ
* Trans

The README also notes that 40+ preconfigured flags, including national, tribal, and in-game state flags, are not included in the free release.

### Key Features

* Carry flags in hand
* Drop and pick up flags with configurable keybinds
* Client and server-side logic
* Item checks
* Object attachment handling
* Animation flow
* Drop and pickup distance logic
* Cleanup logic on death or respawn
* Optional slash commands
* Optional item requirements
* Configurable support for different frameworks

### Installation

1. Put the folder `yourmaps_flags` inside your RedM server `resources` directory.
2. Add the resource to your `server.cfg`.

```cfg
ensure yourmaps_flags
```

3. Open `config.lua` and adjust the settings, keybinds, translations, framework options, and flags to your preference.
4. Create the flag items in your inventory system.

The script uses inventory items to spawn flags. You can create the items using your framework item registration method or by inserting them into your database via SQL. The GitHub README mentions that usable flag items are listed inside `config.lua` and SQL files for easier copy/paste into your item database.

### Good For

This script is useful for:

* Server identity flags
* Country flags
* Tribe flags
* Group flags
* Gang flags
* Family flags
* Event flags
* Parade or ceremony roleplay
* Political or town roleplay
* Camps, forts, businesses, and faction areas

### Works Well With

YourMAPS FlagScript can be used together with the [**YourMAPS Flags Props Package**](https://yourmaps.tebex.io/package/6472550).

The free script gives you the system to carry, drop, and pick up flags, while the props package can expand the number of available flag models for your server.

You can use the free **YourMAPS FlagScript** with this flags package:

[Download YourMAPS FlagScript FREE](https://github.com/zetafe1/yourmaps_flagscript/tree/main)

### Custom Flags

YourMAPS can also create custom flags for servers, gangs, groups, families, companies, businesses, and roleplay organizations.

Prices may vary depending on the request, design complexity, and quantity of flags needed.

### Important

This is a free open-source script.

You can edit, expand, or adapt the code to fit your server needs. If you add new features or improvements, we encourage you to share them with the community so others can benefit too.

### Support

* Questions or doubts: join the YourMAPS Discord.
* For personalized exterior/interior textures, custom buildings, or custom props: open a ticket on Discord.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://yourmaps.gitbook.io/yourmaps-docs/yourscripts/yourmaps-flagscript.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
