https://github.com/brycecanyoncounty/bcc-holidays

A holiday script for your redm server!
https://github.com/brycecanyoncounty/bcc-holidays

cfx redm

Last synced: 4 months ago
JSON representation

A holiday script for your redm server!

• Host: GitHub
• URL: https://github.com/brycecanyoncounty/bcc-holidays
• Owner: BryceCanyonCounty
• Created: 2023-12-03T07:39:47.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-26T01:35:53.000Z (over 1 year ago)
• Last Synced: 2025-03-27T18:22:12.141Z (about 1 year ago)
• Topics: cfx, redm
• Language: Lua
• Homepage:
• Size: 22.5 KB
• Stars: 0
• Watchers: 0
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Bcc Holidays

> A holiday script for your redm server!

## How to install

* Download this repo

* Copy and paste `bcc-holidays` folder to `resources/bcc-holidays`

* Add `ensure bcc-holidays` to your `server.cfg` file (ABOVE any scripts that use it)

* Now you are ready to get coding!

## Features

- Devmode (Easily add new gitbox and display item locations)

- Display Items (Scarecrows, xmas trees, etc)

- Giftbox 

    - Get a random item when found

    - Reset on server restart, or permanent use

- Weather sync support for permanent Snow on ground

![image](https://github.com/BryceCanyonCounty/bcc-holidays/assets/10902965/bbe815a7-4d12-4764-97cf-575a51a0df71)

![image](https://github.com/BryceCanyonCounty/bcc-holidays/assets/10902965/3be9e8b6-c859-4768-8167-a8a8c2a53aa2)

## How to add new giftboxes

1. In config set `Config.Devmode = true` (It is recommended to do this in a test server or instance)

2. Type command `setgiftbox` once to show placement sphere

3. Type command `setgiftbox` again to then add a new giftbox location

4. Make sure to turn devmode off when done.

## How to add new Display Items (Example trees)

1. In config set `Config.Devmode = true` (It is recommended to do this in a test server or instance)

2. Type command `setdisplayitem` once to show placement sphere

3. Type command `setdisplayitem` again to then add a new giftbox location to a file named `displayitems.json`

4. Copy paste the x, y, z values to the `Config.DisplayItemLocations` to add new Display Items