Skip to content

Bill3621/CustomItems

Repository files navigation

🚀 CustomItems LabAPI

CustomItems LabAPI is a flexible and powerful plugin framework for creating and managing custom items in SCP: Secret Laboratory. It provides a structured API for defining, registering, and handling custom items with ease. This repo includes example implementations and core utilities to enhance plugin development with item behaviors, event hooks, and command interfaces.


📚 Table of Contents


✨ Features

  • 🛠️ Define custom items with unique behaviors
  • 📦 Register and manage items through the API
  • 💣 Includes example items like an EMP Grenade
  • ⚡ Hook into custom item-related events
  • 💬 Interact via a built-in command system
  • 📝 Logging utilities for debugging and monitoring
  • 🧪 Future support for item spawning in the pipeline!

🏁 Getting Started

  1. Download the latest release from the Releases Page.

  2. Or clone the repository to build from source:

    git clone https://github.com/Bill3621/CustomItems.git
  3. Build from source:

    • Open CustomItems-LabAPI.sln in Visual Studio.
    • Restore any missing NuGet packages.
    • Build the solution.
    • Place the built DLL into your server's plugins folder.

🛡️ Usage

  • Create a new item by inheriting from API/CustomItem.cs.
  • Implement the required behavior logic.
  • Register your item via API/CustomItems.cs.
  • Use in-game or console commands to interact with your items.

💡 This modular setup allows easy integration and expansion!


📦 Example

Want a concrete implementation? Check out API/Example to see how to build a functioning custom item with event hooks and effects!


🤝 Contributing

We love community contributions! ❤️ To contribute:

  1. Fork this repo
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📬 Contact

Created and maintained by Bill3621. Feel free to open an issue or reach out via GitHub!


📄 License

This project is licensed under the MIT License.