Skip to content

OMEGA3065/CBCI-API

Repository files navigation

Component Based Custom Item API (CBCI-API)

An API which brings many of (my) favourite featuers from EXILED's Custom Item implementation over to LabAPI. You can find examples on how to use the API in the Examples folder.

Installation

Install this as any other LabAPI plugin. Installation guide in the LabAPI Readme.

Developer Package reference

This Library is also avalible as NuGet package. See: https://www.nuget.org/packages/Omega3065.ComponentBasedCustomItemAPI/

Developer Wiki

At this momement the only wiki is viewing the quite well commented code in combination with looking at the provided Examples.

Current Features

  • Items defined as a definition with an item instance class iniciated for each new item.
  • Item Components which affect the behaviour of any item they are attached to.
  • Support for CustomItems (basic), CustomKeycard (all 4 basegame types), CustomFirearms and CustomGrenades.
  • Most portions of the API should be documented in the source-code providing hover-tooltips in most modern editors.
  • A number of default components including compotability with ProjectMER which allows attaching schematics to pickups and held items.

Recently Added Features

  • Integration with ProjectMER.
    1. Custom Pickup model support
    2. Held Item model support
  • Integration with RaCustomMenu
    1. Give custom items to players using the UI (Dummies Tab in RA)
  • Radio and Grenade feature related components.

Planned Features

  • Autogenerated wiki
  • Custom Armor support
  • Even More default components

Contributing

Uses https://www.conventionalcommits.org/en/v1.0.0/ as a commit standard.

Credits

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages