-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathAbout.cs
More file actions
44 lines (36 loc) · 2.5 KB
/
About.cs
File metadata and controls
44 lines (36 loc) · 2.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
namespace ScriptedEvents.DemoScripts
{
using System;
using ScriptedEvents.API.Constants;
/// <summary>
/// Demo script providing information to the server host.
/// </summary>
public class About : IDemoScript
{
/// <inheritdoc/>
public string FileName => "README";
/// <inheritdoc/>
public string Contents => @$"!-- DISABLE
# Hello, and thank you for using our plugin, Scripted Events!
# We're going to go over a couple of brief things in here you should know about setting up scripts. It's relatively easy!
# First and foremost, all scripts must be placed inside of the 'Scripts' folder in order to be executed. Otherwise, the plugin will not recognize them as executable scripts.
# Additionally, the Scripts folder will generate on server startup full of already-functioning scripts. You do not have to keep them, and you can delete the ScriptedEvents folder to re-generate them.
# All scripts in the Scripts folder can be loaded and executed by running ""script ex [filename]"" or ""run [filename]"" in-game (without the .txt extension).
# 'script.execute' permission is required to execute scripts (unless specified otherwise in config).
# Any line starting with a # will be ignored and can be used to comment what you're doing, TODOs, etc.
# Adding ""!-- DISABLE"" at the start of the script will disable its execution in-game. Useful for WIP/broken scripts.
# Almost every action that takes a message or number supports variables, eg. '{{PLAYERSALIVE}}' to get the amount of players alive.
# This plugin contains A LOT of features. You will likely get confused at first. That's okay, that's why documentation (and support) is here.
# The majority of this plugin's features are documented through the ""shelp"" server console command. Simply type ""shelp"" in your server console to get started!
# Lastly, have fun! This is meant to be a fun plugin to mess around with, as well as a utility plugin to create what you can imagine without the need for a custom plugin.
# If you have any questions, do not hesitate to join the Discord server and ask! We're here to help you!
# - {MainPlugin.Singleton.Author}
# GitHub: {MainPlugin.GitHub}
# Discord Server: {MainPlugin.DiscordUrl}
# Scripted Events Contributors:
{Constants.GenerateContributorList('#')}
# File Generated at: {DateTime.UtcNow:f}
# Plugin Version (as of generation): {MainPlugin.Singleton.Version}
# Experimental DLL: {(MainPlugin.IsExperimental ? "YES" : "NO")}";
}
}