OpenJS-docs
Download plugin
  • Overview
    • Welcome
  • Getting Started
    • Installing the plugin
    • Configuration file
    • Commands
    • Creating scripts
  • OpenJS Components
    • Feature Flags
    • Managing scripts within scripts
    • Sharing variables between scripts
    • Custom Commands
    • Using PlaceHolderApi
    • Listening and cancelling events
    • Custom events
    • Loading and saving data
    • Logging in console
    • Scheduling
    • Java imports
  • Example Scripts
    • spawn hit stand command
    • Knockbackstick command
    • No hit-cooldown script
    • NoBlockPlacing script
    • Saving Player data script
    • running code asynchronously
    • WhileTrue do script
Powered by GitBook
On this page
  1. Getting Started

Configuration file

A configuration file will only appear in the plugins/OpenJS/config.yml path after the plugin has been loaded at least once

Config.yml

The configuration file allows you to toggle various features to enhance the user experience and tailor OpenJS to your personal preferences. Explanations for the configuration values can be found in the comments:

# Disabling this will make it impossible for you to listen to events
# in your javascript's
LoadCustomEventsHandler: true

# DO NOT DISABLE! Unless you don't use the //!import feature
# and the log.(...) feature inside event handlers
UseCustomInterpreter: true

# Prints in the console, whenever a javascript has been loaded
# by default, scripts that failed to load will print in the console
PrintScriptActivations: true

# Logs in the console, whenever a placeholder gets
# registered or unregistered
LogPlaceHolderActivity: true

# Logs in the console, whenever a custom command
# gets enabled/loaded or disabled/removed
LogCustomCommandsActivity: true

# Will send messages regarding errors and warnings to operators or users who have
# the permission to use the commands from OpenJS
BroadcastToOps: true

# You can disable this, but if you use schedules inside your scripts
# you need to keep it enabled
LoadCustomScheduler: true

# Checks for updates and notifies admins and the console for an update
# you can disable this, but it is better to stay up to date
UpdateNotifications: true

# Allows usage of feature flags, disabling this can decrease script loading times
# feature flags are being used like this "//!Flagname"
# see https://www.spigotmc.org/resources/117328/field?field=documentation
# under the feature flags section for more info
AllowFeatureFlags: true

# opt-in/out from Bstats https://bstats.org/plugin/bukkit/OpenJavaScript/22268
AllowBstats: true
PreviousInstalling the pluginNextCommands

Last updated 4 days ago