NFive

NFive

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

›Getting Started

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

Installing Plugins

Using the NFive Plugin Manager (nfpm) is the recommended way to install plugins into your Five server.

You can use visit the NFive plugin hub or use nfpm search to find available plugins.

Installing

From a terminal in your server directory you can run:

nfpm install <plugin>
nfpm install <plugin>@<version>

Where <plugin> is expected to be a published plugin from the NFive plugin hub, however nfpm also supports installing from other sources.

Recommended Plugins

Without any plugins, clients will be able to connect but will not spawn into the game world. If you are looking to get started with NFive quickly, the following plugins are recommended as the minimum required for a playable server:

  • Loading Screen - A basic demo loading screen.
  • Start - An example of allowing connected players to spawn so they can play.

These can be installed with:

nfpm install NFive/plugin-loadingscreen NFive/plugin-start

Once you have installed the basic plugins you can move on to starting the server.

Last updated on 5/14/2019
← Server SetupAdministration →
  • Installing
  • Recommended Plugins
NFive
Docs
Getting StartedPlugin ManagerAPI Reference
Community
Getting HelpProject ChatDiscord NFive chat
More
Plugin HubGitHubNFive stargazers on GitHub