Konijima / PZ-Community-API

Community API is a team effort to centralize & give mod creators optimized tools for creating quality mods.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Banner

Description

Community API is a team effort to centralize & give mod creators optimized tools for creating quality mods.
For mod compatibility and efficiency, working as a team ensure that the API is updated and optimized.

Game Version: 41.56-IWBUMS
Links: Wiki | Projects | Workshop | Documentation | Emmylua

Team

Developers:

Informations

Coding Convention | Template API | Utilities

API List

  • BodyLocationsAPI (Shared)
    Tweak body locations without overwritting BodyLocations.lua.
  • DistributionAPI (Server)
    Easily manage your distribution tables.
  • ItemTooltipAPI (Client)
    Make complex custom item tooltip for your new items.
  • LightAPI (Client)
    Add persistent light anywhere in the world.
  • SpawnerAPI (Client | Server)
    Spawn vehicles, items and zombies anywhere in the world.
  • WorldSoundAPI (Client)
    Add persistent sounds anywhere in the world.

Workflow

  • Create/Publish a new branch named <api_name> - <feature>.
  • Do your work on that branch.
  • Commit your changes by prefixing your API name in the title.
    Example -> DistributionAPI: Added new feature
  • When you are ready to release an update create a Pull Request.
  • Assign the Pull Request to your project and assignees.
  • After quality control the merge will be completed.
  • The branch will be deleted.
  • Repeat the same process.

Guideline

  • Commits should be prefixed with the API name.
  • Each API have a Github Project to organize itself.
  • Each API have a Github Wiki section for instruction on how to use the API.
  • Workshop update weekly or daily if hotfix are required.
  • API Developers must agree together to work on someone else API.
  • Each API must be annoted and optimized.
  • Readme can be updated without creating new branches.

About

Community API is a team effort to centralize & give mod creators optimized tools for creating quality mods.

License:MIT License


Languages

Language:Lua 100.0%