APDetectorArtifacts 0.0.5

This plugin adds artifacts when a metal detector flag is destroyed. Players using a metal detector can place flags, and when they are broken, they can receive random artifacts with different drop chances.

Main Features:

• Added API hooks for external plugin integration.
• Multiple levels of metal detectors with different detection rates.
• Configurable artifacts: adjust drop rates, amounts, and rarity.
• Flexible detector system: add new levels via configuration.
• Logs all player actions: flag placement, destruction, and artifact findings.
• Localization support (Russian, English, Ukrainian).

⚙ Settings:

• All parameters can be changed in the configuration file. You can:
• Modify artifact drop chances.
• Configure detector levels and permission-based chances.
• Define which crates can contain detectors.

  Permissions:

apdetectorartifacts.default – standard drop chances.

apdetectorartifacts.vip – increased chances for VIP players.

apdetectorartifacts.premium – maximum chances for premium players.

CFG:
 

{
  "Notify on artifact found": true,
  "Maximum artifacts per flag": 2,
  "Maximum detectors per crate": 2,
  "Random drop mode": true,
  "Detectors": [
    {
      "Short Name": "metal.detector",
      "Enabled": true,
      "Name": "Detector lvl-1",
      "Skin ID": 3380890235,
      "Detection chances by permission": {
        "apdetectorartifacts.default": 55,
        "apdetectorartifacts.vip": 65,
        "apdetectorartifacts.premium": 100
      },
      "Spawn crates": [
        "crate_normal",
        "crate_elite",
        "supply_drop"
      ],
      "Artifacts": [
        {
          "Name": "Artifact 'Fire Stone'",
          "Short Name": "metal.fragments",
          "Skin ID": 2734515256,
          "Drop Chance": 100,
          "Amount": 1
        },
        {
          "Name": "Artifact 'Glowing Ball'",
          "Short Name": "ducttape",
          "Skin ID": 2924517156,
          "Drop Chance": 100,
          "Amount": 1
        }
      ]
    },
    {
      "Short Name": "metal.detector",
      "Enabled": true,
      "Name": "Detector lvl-2",
      "Skin ID": 3380891598,
      "Detection chances by permission": {
        "apdetectorartifacts.default": 65,
        "apdetectorartifacts.vip": 75,
        "apdetectorartifacts.premium": 100
      },
      "Spawn crates": [
        "crate_normal",
        "crate_tools",
        "crate_elite",
        "supply_drop"
      ],
      "Artifacts": [
        {
          "Name": "Artifact 'Fire Stone'",
          "Short Name": "metal.fragments",
          "Skin ID": 2734515256,
          "Drop Chance": 100,
          "Amount": 1
        },
        {
          "Name": "Artifact 'Glowing Ball'",
          "Short Name": "ducttape",
          "Skin ID": 2924517156,
          "Drop Chance": 100,
          "Amount": 2
        }
      ]
    }
  ]
}

API Hooks:
 

I have added an API for integration with other plugins. Here’s what has been done:

Added API Hooks:

OnArtifactFound – Called before an artifact is given, allowing other plugins to cancel the drop.

OnArtifactGiven – Called after an artifact has been given.

OnFlagDestroyed – Called when a flag is destroyed.

Added API Methods:

RegisterArtifactHandler – Allows other plugins to register handlers for specific artifacts.

UnregisterArtifactHandler – Allows unregistering a previously registered handler.

OnArtifactFound(BasePlayer player, ArtifactConfig artifact)
Called before an artifact is given, can be used to cancel the drop.

OnArtifactGiven(BasePlayer player, ArtifactConfig artifact, Item item)
Called after an artifact is granted to a player.

OnFlagDestroyed(BasePlayer player, Vector3 position, DetectorConfig detector)
Called when a metal detector flag is destroyed.

Compatibility: Oxide/uMod.
 

This plugin is actively being developed, with plans to make it more engaging and functional!

This plugin works well in combination with other plugins that utilize custom item mechanics! (I will soon release a new plugin that will work alongside APDetectorArtifacts.)