Advent Calendar (40+ Rewards & All Gamemodes)

The addon comes with 40+ pre-configured rewards that you can enable/disable to your liking.

The addon will work on all gamemodes, but some rewards are gamemode specific. Make sure to enable/disable the ones that suits your servers compatibility.

🎅 Advent Calendar

• Calendar can open up when the player spawns.
• It can also be opened via a chat command.
• You can also spawn an NPC that lets players access the calendar. This is optional.
• You are able to configure the likeliness of each reward. This is how you define chances for a reward to be given vs others.
• Optionally, you can enable rewards only for specific dates. See this knowledge base article.

📜 Calendar History

• Calendar history shows all squares opened by all players on the server during Christmas.
• The history is cached, but updates upon request after 10 minutes.
• This can be configured for longer/shorter cache values.

🏆 Coal Leaderboard

• The coal leaderboard shows who collects the most coal during Christmas.
• It will show the top 10 players in the list.
• The list is also cached for performance and updates upon request after 10 minutes.

💵 Valuta Rewards

• DarkRP Money
• TTT Credits
• Give tokens with mTokens
• Give cryptocurrencies with Cryptos
• Give credits with Onyx Store
• Give points with CH Purge
• Give money to bank account with ATM
• Give credits for Brick's Credit Store

🪙 PointShop Rewards

• Give points with PointShop1
• Give item with PointShop1
• Give standard points with PointShop2
• Give premium points with PointShop2
• Give specific item with PointShop2
• Give random item with PointShop2
• Give random item from list with PointShop2
• Give item with SH Pointshop
• Give standard points with SH Pointshop
• Give premium points with SH Pointshop
• Give item with Advanced Accessory
• Trigger giveaway for aShop
• Give standard points with aShop
• Give premium points with aShop
• Give item for aShop

💯 XP Rewards

• Give XP with gLevel
• Give XP with DarkRP Essentials or Brick's Essentials
• Give XP with Sublime Levels
• Give XP with Vrondakis Level System
• Give XP with GlorifiedLeveling
• Give XP with Elite XP System
• You are also able to give an amount of XP for simply opening a square every day. See the config.

🚗 Car Dealer Rewards

• Give car with Modern Car Dealer
• Give car with Realistic Car Dealer
• Give car with William's Car Dealer

⚔️ WiltOS Rewards

• Give level with WiltOS
• Give XP with WiltOS
• Give an item with WiltOS

🔫 Weapon Rewards

• Give random weapon from list.
• Give weapon ammunition.
• Give weapon skin with Easy Skins
• Give permanent weapon with PermaWeapons

🛡️ Other Rewards

• Give specific medal with Medals
• Give armor.
• Give case with VoidCases
• Whitelist team with Billy's Whitelist
• No gravity.
• Speed booster.
• Give candy with Zero´s PumpkinNight (Halloween / Christmas Script)
• Activate a global boost with Boost Upgrades

💾 MySQL Support

• By default the addon saves using SQLite that comes with GMod.
• You can enable MySQLOO saving. See the "Setup" tab.
• Both options are efficient to use, however, mysqloo is recommended.

💻 bLogs Support

• The addon supports bLogs.
• Logs when a player opens a square (player name, square, reward name).

🌎 Language System

• English
• French
• Danish
• Spanish
• Polish
• Russian
• German

I will gladly add any reward to the script if you just leave a comment in the discussion section, or if you as an existing customer open a support ticket with your request. It can be for anything pretty much, but I would prefer if it had something to do with something publicly available or a gmodstore script.

Discord Server

I own a Discord server for customers and anyone else who wish to join. I will occasionally provide exclusive offers and help with minor issues that might occur with my scripts. If you have a more serious problem, please create a support ticket on GModStore.

This addon supports all gamemodes.

Extract ch_advent_calendar to your addons folder.

Please visit the Setup & Customizing tab to see how you configure the addon.

CONTENT

There's a single content pack that you must add to your servers workshop collection.

Workshop

SEE THE SETUP TAB FOR NPC AND MYSQL DETAILS

SETUP NPC

The NPC is completely optional. If you want to use it then you can enable it in the config.

To spawn it simply join the server as as super admin.

Run console command in-game ch_advent_setnpcpos to spawn it.

It will face in your direction.

MYSQLOO

By default the addon saved using sqlite (default build into gmod). If you wish to enable MySQLOO then you can do so.

Go to the file lua/ch_advent_calendar/server/sv_sql.lua

Set the CH_Advent.SQL.UseMySQLOO config to true

Then fill in your information below. This will of course require that you have the MySQLOO module by FredyH.

CONFIG

The configure the general aspects of the addon go to ch_advent_calendar/lua/ch_advent_calendar/shared/sh_config.lua

The configure the rewards go to ch_advent_calendar/lua/ch_advent_calendar/shared/sh_rewards.lua

--[[
	General
--]]
CH_Advent.Config.Language = "en" -- Set the language of the script.

CH_Advent.Config.NotificationTime = 10 -- How long will notifications last?

CH_Advent.Config.BottomMenuText = "Community Name • Advent Calendar 2024"

CH_Advent.Config.CanOpenMissedSquares = true -- Should players be able to open missed squares?

--[[
	Menu
--]]
CH_Advent.Config.OpenMenuOnConnect = true -- Should the advent calendar open when they spawn after connecting?

CH_Advent.Config.UseChatCommand = true -- Should we enable the chat command?
CH_Advent.Config.MenuChatCommand = "!advent" -- Chat command to open the menu

CH_Advent.Config.ShowRewardTooltip = true -- When hovering over an opened square should we show a tooltip with the reward they got?
--[[
	History
--]]
CH_Advent.Config.HistoryCacheTime = 600 -- We keep the cache of the history for 600 seconds. After that it will be fetched from the DB upon next request.
CH_Advent.Config.LeaderboardCacheTime = 600 -- We keep the cache of the leaderboard for 600 seconds. After that it will be fetched from the DB upon next request.

--[[
	Reward
--]]
CH_Advent.Config.ConfettiOnReward = true -- Emit a confetti effect from the player when opening a reward (not coal)
CH_Advent.Config.SoundEmitOnReward = true -- Emit a sound from the player when opening a reward (not coal)

CH_Advent.Config.RewardXPOnOpenSquare = true -- Aside from the other reward in a square, should we give an amount of XP when opening a square (regardless of the reward)?
CH_Advent.Config.RewardXPAmount = 25 -- If enabled above we give this XP every time they open a square.

You are also able to configure each square color in the calendar.

If you find any problems with the script, please create a support ticket with details of the situation and a copypaste of the error in console.

Conflicting addons is not to be said if I will support that or not. This is something I will decide upon confrontation about a conflicting addon. If you have found a conflicting addon, then feel free to open a support ticket and I'll see if I can assist with solving the conflict.

Thank you!

Credits

Banners and icons by astral

Font is Outfit and Caveat Brush by Google

User interface design inspiration from Claire Pinor on Dribbble

Idea from Maurice

If you like this script, you should check out some of my other addons for DarkRP. Just click the banner to open the script page in a new tab.