The Offering

Works with

About The Offering

Get your Entire Server to Grind towards a Common Goal.

With The Offering, Set Item Requirement amounts, either custom or vanilla.

REQUIRED FOR UI - IMAGELIBRARY

REQUIRED FOR MAPMARKER - MARKERMANAGER

Top Contributors can now be rewarded via Commands in Config.

What will you reward your Players with?

Skill Points? Unload TruePVE and let a purge play out? Or just run a command for Economics deposit and fill everyone's account to congratulate everyone's hard work.

At Offering Fulfilled you can run as many commands as you like to reward your Players.

You can also Utilize The Offering to get rid of excess items. Maybe Players have too much scrap at the end of the wipe, add scrap as a requirement and let the excess scrap serve a purpose.

Upon Valid Item Deposit, The Box shoots a flame and accepts The Offering, Invalid Items get tossed back out of the Box for the player to recollect.

Players can utilize an optional UI to track resources that are needed towards completion.

It can be toggled on via /OUI or disabled by clicking the x on the UI Tab.

UI position can be easily set via UI Location Config Option.

Update interval for multiple item requirements can be set, to update the UI to show the other unfulfilled items.

If there is a placeholder image and it doesn't retrieve, you can use the custom URL for a PNG as well. This is also useful for custom items.

Skin for the box can be set in config.

Discord Tracking of the Offering Box Status can be set in config.

If an Offering is complete, you have the option to respawn the box at a certain time frame, or disable the respawn completely and have it a one off event, or an event whenever you feel like holding it.

MULTIPLIER INFORMATION

Default Multiplier in config can be used to quick modify your requirement amounts.

You can have this dynamically increase on Offering Completions by enabling this option.

Default Multiplier of 1 is a 1:1 of your current requirements.

If you increment by .5, Your multiplier becomes 1.5 on the next offering.

Keep in mind giving items with 1 value, you can't issue half of an AK.

Requirements will round up or down depending on the amount when the math is done.

Max Multiplier will never be passed, and will always reset to this value upon it being hit.

A multiplier can dynamically effect your Global Commands and Top Contributor Rewards.

Use {x} to modify the amount, for example - a command for economics. "deposit * 1000{x}"

This will multiply that integer value by your current multiplier, More info can be seen in default config below.

This can also be used in your Rewards Description field, if you want to say, Everyone will get 100{x} SP.

Multiplier does not apply towards Rush Mode.

Multiplier Demonstration

Rush Mode Info

Rush is an optional mode, it uses separate reward methods and requirements for a condensed version of The Offering for small events.

The player with the highest score (If point mode is on) Or Deposits.

Will win x Commands you issue.

If the plugin unloads an early end will trigger and issue commands to the winners you specify in config.

If the plugin is unloading during a server reboot, the plugin will save those commands to run on next boot due to some plugins being unloaded, by the time The Offering is unloaded.

The Item Amount in the Rush Requirement is a field you can ignore. Since highest deposits are what counts, item deposits are unlimited.

If discord logging is enabled, it will log your top contributors, and will also notify if an event ended during a shutdown.

NEW COMMANDS FOR RUSH MODE ARE FOUND BELOW IN THE COMMANDS SECTION

Video Demos

https://youtube.com/clip/Ugkxz8_UG6AqGRZSrwF5JVippAvCPIgWfIHs?si=IKL6D46gwn5MHDrw

COMMANDS

CONSOLE COMMAND - RESETMULTIPLIER - RESETS YOUR MULTIPLIER TO YOUR DEFAULT VALUE

/OUI - Toggles the UI on or off

/beginoffering - console or chat, To start an offering if one isnt pending respawn, or if one isnt ongoing in the world, only Works with Dynamic Spawn.

/ConvertToOffering - Allows you to convert an already placed Large Wooden Box, To an Offering Box - THEOFFERING.ADMIN - PERMISSION REQUIRED

/RemoveOffering - Removes The Offering Box you are looking at - THEOFFERING.ADMIN - PERMISSION REQUIRED

/givebox - Gives the player a placeable box that will convert to an offering box on placement - THEOFFERING.ADMIN - PERMISSION REQUIRED

/offeringstatus - Will print the offering status to the executing player

/offeringtop - Will print the top offering contributors to the executing player

/giveofferingitems - Will Send all your offering items to your inventory - admin

/myofferingstats - Will show the players current standings if any.

/offeringleaderboard - Will show the top standings via UI,, with different banner text depending on point mode or regular mode.

/rush on - Will reload the plugin with rush enabled, use beginoffering or place a box if you don't have a dynamic pos enabled.

/rush off- Will reload with regular offering mode enabled

NOTE - IF RUSH ON / OFF IS RAN WHILE IT IS IN THAT MODE, IT WONT SWAP MODES

HOOKS

OnOfferingActive - Void

OnOfferingInactive - Void

OnOfferingSatisfied - Returns a StorageContainer to run custom code at container at end.

OnOfferingRushModeStarted - Void

OnOfferingRushModeEnded - Void

Support for ServerPanel by Mevent - To Set up - Type - "Plugin" - Hook - "OpenOfferingLeaderboard"

CONFIG

{
  "Box Options": {
    "Enable Incrementing Requirements on Regular Offering Completions?": true,
    "Starting Multiplier - Default 1 - This Value is used even if Increment Requirements is Disabled, it can be used to Quick Increase each needed Item totals": 1.0,
    "Increase Multiplier by This Value on Completion, A Starting Multiplier of 1 Incremented by 0.5 will be a 1.5 multiplier resulting in a 50% Requirement Increase": 0.5,
    "Maximum Offering Multiplier to Reach by Incrementing": 5.5,
    "Allow Multiplier to Multiply Global Commands? (Int Value must be followed with {x} - Ex:10{x})": true,
    "Allow Multiplier to Multiply Top Contributor Commands? (Int Value must be followed with {x} - Ex:10{x})": true,
    "Enable UI on Offering Box Open?": true,
    "Path for Image on Offering Box Opened": "https://www.dropbox.com/scl/fi/2zkykpsa05q2nn9xfhxlg/OfferingBox.png?rlkey=dmmropc8u5x2wqo1ot7ad00l1&st=qldojnor&dl=1",
    "Enable Effect on Box Open?": true,
    "Path for Effect on Offering Box Opened": "assets/content/vehicles/attackhelicopter/effects/pfx_flares_attackhelicopter.prefab",
    "Enable Point Mode for Leaderboard?": false,
    "Enable The Offering Rush Mode? (This mode does not Data Track, Is meant for quick, Contribution Competitions)": false,
    "Rush Mode Duration?": 600,
    "Dynamic Spawn Of The Box Enabled?": false,
    "Dynamic Spawn at this Monument (Requires your Position Input to be set to match Monument if Changing from Default.)": "assets/bundled/prefabs/autospawn/monument/medium/compound.prefab",
    "Dynamic Spawn Point (Relative to Monument)": {
      "x": -18.17,
      "y": 0.42,
      "z": 20.64
    },
    "Dynamic Spawn Rotation Correction": 90.0,
    "Offering Box Skin Id": 1900496901,
    "Placeholder SkinID for /givebox Command, Box Reverts to the above skin on placement.": 3174587477,
    "Respawn Offering Box a Few Seconds after Previous Box Completion?": true,
    "Respawn Delay in Seconds": 10,
    "Clear Data on Wipe?": false
  },
  "Rush Mode Options": {
    "Item Requirements": [
      {
        "Item Shortname": "blood",
        "Amount Of This Item Required": 0,
        "Point Value": 1,
        "Custom SkinID": 0,
        "Item Custom Name": "",
        "Item Image URL (For UI)": ""
      },
      {
        "Item Shortname": "sticks",
        "Amount Of This Item Required": 0,
        "Point Value": 1,
        "Custom SkinID": 0,
        "Item Custom Name": "",
        "Item Image URL (For UI)": ""
      }
    ],
    "Contributor Rewards": [
      {
        "Rank Rewards (1 for 1st place, 2 for 2nd, etc.)": 1,
        "Commands to Run for this Contributor": [
          "inventory.giveto {id} rifle.ak 1"
        ]
      },
      {
        "Rank Rewards (1 for 1st place, 2 for 2nd, etc.)": 2,
        "Commands to Run for this Contributor": [
          "inventory.giveto {id} rifle.ak 1"
        ]
      },
      {
        "Rank Rewards (1 for 1st place, 2 for 2nd, etc.)": 3,
        "Commands to Run for this Contributor": [
          "inventory.giveto {id} rifle.ak 1"
        ]
      }
    ],
    "Rush Mode Rewards Description": "Top Players Will Receive x Commands Upon Offering Rush Win"
  },
  "Items Needed For Fulfillment Message Cooldown Time in Seconds?": 30,
  "Items Added to Box Message Cooldown Time in Seconds?": 5,
  "Item Fulfilled Message Cooldown Time in Seconds?": 30,
  "Enable UI?": true,
  "UI Location (top right, lower top right, bottom right, top left, lower top left, bottom left": "lower top right",
  "UI Update Interval In Seconds": 30,
  "Announcement Interval In Seconds": 600,
  "Use Announcement FX?": false,
  "Broadcast Updates on Status To Discord?": false,
  "Broadcast Top Contributors To Chat?": false,
  "Amount of Players to Announce on Top Contributors?": 5,
  "Discord Webhook URL?": "",
  "Item Requirements": [
    {
      "Item Shortname": "blood",
      "Amount Of This Item Required": 100,
      "Point Value": 1,
      "Custom SkinID": 0,
      "Item Custom Name": "",
      "Item Image URL (For UI)": ""
    },
    {
      "Item Shortname": "sticks",
      "Amount Of This Item Required": 100,
      "Point Value": 1,
      "Custom SkinID": 0,
      "Item Custom Name": "",
      "Item Image URL (For UI)": ""
    }
  ],
  "Commands To Run On Offering Satisfied": {
    "Commands List": [
      "say The offering has been satisfied!",
      "say Another command goes here",
      "say Yet another command",
      "here you can unload TruePve",
      "say The Current Offering Multiplier is 1{x}",
      "say depositing 1000{x} to all",
      "deposit * 1000{x}"
    ]
  },
  "Rewards Description": "The server will award 1000{x} XP Upon Offering Satisfied",
  "Enable Top Contributor Rewards?": true,
  "Top Contributor Rewards": [
    {
      "Rank Rewards (1 for 1st place, 2 for 2nd, etc.)": 1,
      "Commands to Run for this Contributor": [
        "inventory.giveto {id} sulfur 10{x}"
      ]
    },
    {
      "Rank Rewards (1 for 1st place, 2 for 2nd, etc.)": 2,
      "Commands to Run for this Contributor": [
        "inventory.giveto {id} rifle.ak 1{x}"
      ]
    },
    {
      "Rank Rewards (1 for 1st place, 2 for 2nd, etc.)": 3,
      "Commands to Run for this Contributor": [
        "inventory.giveto {id} rifle.ak 1{x}"
      ]
    },
    {
      "Rank Rewards (1 for 1st place, 2 for 2nd, etc.)": 4,
      "Commands to Run for this Contributor": [
        "say Add More Like Me!",
        "say You can Run Multiple Commands!",
        "say Target players id with {id}",
        "say you can use 1{x} to multiply your reward by your multiplier"
      ]
    }
  ]
}