Skip to content

SCriPt v0.1.0

Pre-release
Pre-release

Choose a tag to compare

View all tags
@tayjay tayjay released this 30 Jun 17:13
· 25 commits to master since this release
v0.1.0-alpha
c616edf

First Official Pre-release!

This should be a functional build of the SCriPt plugin. The name is an attempt to combine "SCP" and "script".

Please read the documentation from this repo's Wiki. It includes examples of what can be done with the plugin. You'll require the MoonSharp library for this plugin to run, information on that can be found in the Getting Started guide.

Features

  • Write .lua files that execute code when EXILED events are fired.
  • Configuration options to change how much access the plugin has to your host (Defaults give limited access, but can go as far as running system commands when events trigger if you so choose)
  • No compiling of C# libraries to prototype changes
  • Allowing Server owners automation options that hook into the game without writing a plugin.
  • A basic API bridge for other plugins to expand on what this plugin can do, and expose their own code to be accessible in scripts. See my main plugin collection, TTPlugins, for an example.
  • Connects Lua Coroutines with EXILED's MEC to run code asynchronously. (Config option to limit code execution from infinite loops, but can be disabled for permanent loops)
  • Exposes several EXILED classes and functions using Lua Globals

Known Issues

  • There are bugs, lots, please report them so I can fix them next patch.
  • Not all classes are registered types for use in scripts. This is a technical limitation. "Proxy Types" have been made for some of the commonly used types in EXILED that give access to fields and methods of things like Players, Doors, Rooms, Pickups, Items, etc.
    • Please report any common types that are missing, or try adding them yourself using a custom Lua Global file. These instructions will be in the Docs soon.
  • The lua command for running scripts in game is WIP, you may see varying results, scripts need to be in the root Scripts directory to be executed.

Installation

The Docs have full instructions but here are the basics. Download the SCriPt.dll plugin from here, place it in your Exiled plugins folder. Download the dependencies.zip from here, or follow the docs to get it from the official source and extract it in the EXILED/Plugins/dependencies subfolder. Run your server once to generate the required configs and Script folders. Try writing your first script and place it in the Scripts/AutoLoad folder so it runs on startup (located in the same directory as the "localadmin" install).

Assets 4
Loading