Skip to content
SwiftKraft edited this page Jan 4, 2024 · 6 revisions

Welcome to the SwiftAPI documentation!

This page is the center of the documentation of all features, feel free to explore around.

This wiki will aim to provide with you all the knowledge you need to work with the API, thank you for using SwiftAPI.

The plugin will often be referred to as either "The Plugin", "The API" or "The Library" in this wiki, if there are any confusing parts to this documentation, please feel free to create an Issue.

Overview

SwiftAPI is an open source library plugin for SCP: SL NWAPI servers. This plugin will NOT offer modification to any gameplay, the content is decided by the plugins that use this API, it is intended to make developing plugins easier.

However, there are still some base functions that will work regardless of which plugins that you have installed that will use this API. This documentation will also mention them for non-developers in the For Server Admins section.

If you seek to develop a plugin with this API, you may go to the For Plugin Developers section. This documentation will only explain how to use the API, and expects you to already know how to use the C# coding language and how to make a NWAPI plugin for SCP: SL Servers.

This documentation will cover:

  • Base functions of the API
  • Basic Custom Item creation
    • Firearms
    • Grenades
    • Consumables
  • Advanced Custom Item creation
    • Using Custom Item Events
    • How To Write Custom Logic
  • Easy Command creation
  • What are Targeters and how to use them
  • How to add new Targeters

Clone this wiki locally