NFive

NFive

  • Docs
  • Help
  • API
  • Plugins
  • GitHub
  • Languages iconEnglish
    • Čeština
    • Español
    • Norsk
    • Português (Brasil)
    • Help Translate

›Plugin Development

Getting Started

  • Overview
  • Components
  • Database Setup
  • Server Setup
  • Installing Plugins
  • Administration
  • Troubleshooting

Plugin Manager

  • Overview
  • Command Reference

Plugin Development

  • Overview
  • Setup
  • Hub
  • Definition
  • Server Side

    • Life Cycle
    • Controller
    • Configurable Controller
    • Dependency Injection
    • Database Access
    • RCON

    Client Side

    • Life Cycle
    • Service
Edit

Hub

The NFive plugin Hub if the official plugin repository, which nfpm uses by default.

Purpose

The plugin Hub was designed as a simple centralized location to publish public NFive plugins to for easy install by other users.

Functionality

The plugin Hub works by indexing public GitHub repositories which use the #nfive-plugin topic and have a valid plugin release.

Publishing

In order to publish your plugin to the Hub you must complete the following steps:

  1. Host your project on GitHub, with each NFive plugin in a separate public repository.
  2. Add the five-plugin topic to your repository.
  3. Pack your built project into a ZIP file, either with nfpm pack or manually.
  4. Create a release on GitHub, attaching the packed plugin.

The Hub will update and discover new plugins every hour, so their may be a delay before your new plugin release is available.

Last updated on 5/14/2019
← SetupDefinition →
  • Purpose
  • Functionality
  • Publishing
NFive
Docs
Getting StartedPlugin ManagerAPI Reference
Community
Getting HelpProject ChatDiscord NFive chat
More
Plugin HubGitHubNFive stargazers on GitHub