Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 2.07 KB

README.md

File metadata and controls

47 lines (34 loc) · 2.07 KB

NightLantern

for Rust

This plugin was originally created and developed by me, now is currently mantained and developed by k1lly0u of Oxide community. This GitHub version (1.2.0) refers to last version I uploaded. For last, stable, full functioning version (and its documentation) download latest release here.

NightLantern is a C# plugin for Rust, it is meant to be run by Oxide framework. Rust is PC survival game currently in development by Facepunch Studios.

NightLantern handles automatic ignition and shutown of all lanterns placed in the world.

It turns on lantern after sunset and off after sunrise.

Installation

Requirements

Nightlantern is a plugin for Rust modded server, it needs Oxide mod to be executed. First thing you need to do is download and install Oxide.

You can see all Oxide documentation and download link here: http://oxidemod.org/downloads/oxide-for-rust.1659/

Installing NightLantern

Simply download and place NightLantern.cs file into Oxide "Plugins" folder and you will be good to go with defaults configuration.

Configuration

Dropping NightLantern.cs file into plugin folder will generate the relative configuration file into "Config" folder, here are default parameters:

{
  "SunriseHour": 7.5, 
  "SunsetHour": 18.5,
  isAutoTurnLanternsEnabled = false,
  includeJackOLanterns = false,
  includeCampfires = false
}

You can modify:

  • edit sunset and sunrise hours
  • disable automatic on/off cycle (server admin can manually manage ignition and shutdown via chat commands)
  • choose whether you want to include campfires and Jack-o-Lantern in automatic cycle

Usage

By default automatic cycle is enabled so server admin doesn't need to anything. If automatic automatic cycle is disabled (or a manual touch is needed) chat command Lant can be used:

Chat Command Lant

Server admin can type /Lant {param} where param can take on or off values to manually and instantly handle lanterns (and other deployable included in config file)