Skript Folia
Skript Folia 是 Skript 的一个分支,旨在将 Skript 风格的脚本功能引入基于 Folia 的 Minecraft 服务器。
Skript 允许服务器管理员无需编写完整的 Java 插件即可创建自定义命令、机制、系统和游戏特性。其语法基于可读性强的英语,既便于服务器所有者使用,也适合希望在将其转化为完整插件之前快速构思原型的开发者。
仓库地址:
关于 Skript Folia
Skript 最初由 Njol 于 2011 年在 dev.bukkit.org 上发布,始终致力于让 Minecraft 服务器所有者能够包容性地进行编程。它为管理员提供了一种实用的方法来创建独特的服务器功能,而无需先前的编程经验。
Skript Folia 延续了这一理念,同时针对现代 Folia 服务器环境进行了优化,在这些环境中,传统 Bukkit/Paper 关于同步服务器执行的假设不再总是成立。
Folia 改变了 Minecraft 服务器处理计时(ticking)、区域、实体和调度的方式。因此,在 Paper 上运行的插件可能需要修改才能安全地在 Folia 上运行。Skript Folia 围绕这一兼容性目标构建:在保持 Skript 实用性的同时,适应基于 Folia 的服务器行为。
为什么选择 Skript Folia?
传统的脚本插件通常假设所有世界、实体和玩家操作都在一个全局服务器线程上进行。Folia 并非如此运作。
Skript Folia 的存在是为了通过提高与 Folia 的区域化线程模型的兼容性,使 Skript 能够在 Folia 环境中使用。
它适用于希望拥有以下功能的服务器所有者:
- 自定义命令
- 游戏玩法脚本
- 服务器工具
- 简单原型
- 轻量级自定义系统
- 更快的功能迭代
- 为 Folia 服务器提供脚本层
功能
Skript Folia 包含了熟悉的 Skript 体验,同时专注于 Folia 兼容性。
自然语法
Skript 使用类似英语的简单语法,易于阅读、编写和维护。
示例:
send "Welcome to the server!" to player
基本功能不需要复杂的 Java 设置。
自定义命令
直接从脚本中创建自定义命令。
command /hello:
trigger:
send "Hello, %player%!" to player
命令可以包含权限、描述、别名、参数和自定义行为。
函数
通过定义可重用的函数来避免复制粘贴重复逻辑。
function welcomePlayer(p: player):
send "Welcome, %{_p}%!" to {_p}
函数使脚本更清晰且更易于维护。
变量
存储玩家数据、位置、计数器、冷却时间和其他服务器状态。
set {coins::%player's uuid%} to 100
add 5 to {coins::%player's uuid%}
事件
响应服务器事件,例如玩家加入、离开、聊天、死亡、破坏方块或与世界的互动。
on join:
send "Welcome back, %player%!" to player
清晰的错误消息
Skript 注重可读的错误消息。当脚本包含无效语法或不受支持的行为时,Skript 会以清晰的术语报告问题,以便服务器所有者更快地修复问题。
可扩展
Skript 拥有庞大的附加组件生态系统。附加组件可以通过额外的语法、集成、表达式、效果和条件来扩展 Skript。
在 Folia 上使用附加组件时,请确保每个附加组件也与 Folia 兼容。Paper 兼容的附加组件并不自动保证 Folia 安全。
示例脚本
可以使用 Skript 编写一个简单的回家系统:
command /sethome:
permission: skript.home
description: Set your home
executable by: players
trigger:
set {home::%player's uuid%} to location of player
send "Set your home to <grey>%location of player%<reset>"
command /home:
permission: skript.home
description: Teleport yourself to your home
executable by: players
trigger:
if {home::%player's uuid%} is not set:
send "<red>You have not set your home yet! Run /sethome first."
stop
teleport player to {home::%player's uuid%}
send "<lime>You have been teleported to your home."
要求
Skript Folia 专为基于 Folia 的服务器设计。
推荐的环境:
- Folia 或 Folia 兼容的服务器实现
- 当前 Skript Folia 版本支持的 Minecraft 版本
- 你的目标 Minecraft 服务器版本所需的 Java 版本
不支持 Spigot。
Paper 兼容性取决于当前的分支行为和构建目标。除非发行说明明确说明否则,请在运行 Skript Folia 时使用 Folia。
安装
- 下载最新的 Skript Folia 构建版本。
- 将
.jar 文件放入服务器的 plugins 文件夹中。
- 重启服务器。
- 确认 Skript Folia 成功加载。
- 在以下位置添加
.sk 脚本:
plugins/Skript/scripts/
- 使用以下命令重新加载脚本:
/sk reload <file name>
示例:
/sk reload homes
安装脚本
创建脚本很简单:
- 创建一个以
.sk 结尾的文件。
- 将其放入 Skript 脚本文件夹中。
- 使用
/sk reload <file name> 重新加载它。
示例路径:
plugins/Skript/scripts/example.sk
示例命令:
/sk reload example
安装附加组件
Skript 附加组件像普通插件一样安装:
- 下载附加组件
.jar 文件。
- 将其放入
plugins 文件夹中。
- 重启服务器。
重要提示:附加组件必须与 Folia 兼容。如果附加组件不正确地执行世界、实体、玩家、库存或调度操作,可能会失败或在 Folia 上导致不安全的行为。
在 Folia 服务器上使用前,请务必检查附加组件的文档。
Folia 兼容性通知
Folia 使用区域化线程(regionized threading)。这意味着插件在访问玩家、实体、世界、区块、方块、物品栏和计划任务时必须格外谨慎。
Skript Folia 旨在改善该环境下的 Skript 支持,但脚本行为仍可能取决于以下因素:
- 使用的语法
- 处理的事件
- 目标 Minecraft 版本
- 已安装的附加组件(addons)
- 操作是否涉及世界、玩家、实体或区域状态
如果某个脚本在 Paper 上正常运行但在 Folia 上失败,原因通常是不安全的线程访问或使用了不兼容 Folia 的附加组件。
报告问题
如果你在使用 Skript Folia 时遇到 bug,请在 GitHub 上报告:
报告问题时,请包含以下内容:
- 服务器版本
- Skript Folia 版本
- Java 版本
- 已安装的附加组件
- 完整的错误日志
- 导致问题的脚本
- 重现问题的步骤
Bug 报告应针对 Skript Folia 本身。如需编写脚本的帮助,请使用社区 Skript 资源。
资源
有用的 Skript 资源:
- Skript 文档:
- skUnity:
- SkriptHub:
- 原始 Skript 项目:
Skript Folia 仓库:
贡献
Skript Folia 是一个基于 Skript 的 Java 插件项目。参与贡献需要具备 Java 经验,并了解 Bukkit、Paper 和 Folia 服务器的运行机制。
在贡献之前,请查阅源代码,在 Folia 服务器上测试更改,并确保世界、实体、玩家和调度器逻辑符合 Folia 安全标准。
仓库地址:
总结
Skript Folia 将熟悉的 Skript 脚本体验带入基于 Folia 的 Minecraft 服务器。
它帮助服务器所有者更快速地创建自定义功能,同时保留让 Skript 广受欢迎的简洁性:易读的语法、快速的迭代、自定义命令、可重用的函数以及实用的服务器自动化。
对于需要自定义行为而不必为每个功能构建完整 Java 插件的 Folia 网络,Skript Folia 提供了一个专为现代服务器基础设施设计的灵活脚本层。
Skript Folia
Skript Folia is a fork of Skript focused on bringing Skript-style scripting to Folia-based Minecraft servers.
Skript lets server administrators create custom commands, mechanics, systems, and gameplay features without writing a full Java plugin. Its syntax is based on readable English, making it accessible for server owners while still useful for developers who want to prototype ideas quickly before turning them into full plugins.
Repository:
About Skript Folia
Skript was originally released in 2011 on dev.bukkit.org by Njol and has always focused on inclusive programming for Minecraft server owners. It gives administrators a practical way to create unique server features without requiring prior programming experience.
Skript Folia continues that idea while targeting modern Folia server environments, where traditional Bukkit/Paper assumptions around synchronous server execution are no longer always valid.
Folia changes how Minecraft servers handle ticking, regions, entities, and scheduling. Because of that, plugins that work on Paper may require changes before they can run safely on Folia. Skript Folia is built around that compatibility goal: keeping Skript useful while adapting behavior for Folia-based servers.
Why Skript Folia?
Traditional scripting plugins often assume that all world, entity, and player operations happen on one global server thread. Folia does not work that way.
Skript Folia exists to make Skript usable in Folia environments by improving compatibility with Folia's regionized threading model.
It is intended for server owners who want:
- Custom commands
- Gameplay scripts
- Server utilities
- Simple prototypes
- Lightweight custom systems
- Faster feature iteration
- A scripting layer for Folia servers
Features
Skript Folia includes the familiar Skript experience while focusing on Folia compatibility.
Natural Syntax
Skript uses simple English-like syntax that is easy to read, write, and maintain.
Example:
send "Welcome to the server!" to player
No complex Java setup is required for basic features.
Custom Commands
Create custom commands directly from scripts.
command /hello:
trigger:
send "Hello, %player%!" to player
Commands can include permissions, descriptions, aliases, arguments, and custom behavior.
Functions
Avoid copy-pasting repeated logic by defining reusable functions.
function welcomePlayer(p: player):
send "Welcome, %{_p}%!" to {_p}
Functions make scripts cleaner and easier to maintain.
Variables
Store player data, locations, counters, cooldowns, and other server state.
set {coins::%player's uuid%} to 100
add 5 to {coins::%player's uuid%}
Events
React to server events such as players joining, leaving, chatting, dying, breaking blocks, or interacting with the world.
on join:
send "Welcome back, %player%!" to player
Clear Error Messages
Skript focuses on readable error messages. When a script contains invalid syntax or unsupported behavior, Skript reports the problem in clear terms so server owners can fix issues faster.
Extendable
Skript has a large addon ecosystem. Addons can expand Skript with extra syntax, integrations, expressions, effects, and conditions.
When using addons on Folia, make sure each addon is also compatible with Folia. A Paper-compatible addon is not automatically Folia-safe.
Example Script
A simple home system can be written with Skript:
command /sethome:
permission: skript.home
description: Set your home
executable by: players
trigger:
set {home::%player's uuid%} to location of player
send "Set your home to <grey>%location of player%<reset>"
command /home:
permission: skript.home
description: Teleport yourself to your home
executable by: players
trigger:
if {home::%player's uuid%} is not set:
send "<red>You have not set your home yet! Run /sethome first."
stop
teleport player to {home::%player's uuid%}
send "<lime>You have been teleported to your home."
Requirements
Skript Folia is intended for Folia-based servers.
Recommended environment:
- Folia or a Folia-compatible server implementation
- A supported Minecraft version for the current Skript Folia build
- Java version required by your target Minecraft server version
Spigot is not supported.
Paper compatibility depends on the current fork behavior and build target. Use Folia when running Skript Folia unless the release notes explicitly state otherwise.
Installation
- Download the latest Skript Folia build.
- Place the
.jar file inside your server's plugins folder.
- Restart the server.
- Confirm that Skript Folia loaded successfully.
- Add
.sk scripts inside:
plugins/Skript/scripts/
- Reload scripts with:
/sk reload <file name>
Example:
/sk reload homes
Installing Scripts
Creating a script is simple:
- Create a file ending in
.sk.
- Put it inside the Skript scripts folder.
- Reload it with
/sk reload <file name>.
Example path:
plugins/Skript/scripts/example.sk
Example command:
/sk reload example
Installing Addons
Skript addons install like normal plugins:
- Download the addon
.jar.
- Place it inside the
plugins folder.
- Restart the server.
Important: addons must be Folia-compatible. Addons that perform world, entity, player, inventory, or scheduler operations incorrectly may fail or cause unsafe behavior on Folia.
Always check the addon's documentation before using it on a Folia server.
Folia Compatibility Notice
Folia uses regionized threading. This means plugins must be careful when accessing players, entities, worlds, chunks, blocks, inventories, and scheduled tasks.
Skript Folia is designed to improve Skript support in this environment, but script behavior may still depend on:
- The syntax being used
- The event being handled
- The target Minecraft version
- Installed addons
- Whether an operation touches world, player, entity, or region state
If a script works on Paper but fails on Folia, the cause is often unsafe thread access or an addon that is not Folia-compatible.
Reporting Issues
If you experience a bug with Skript Folia, report it on GitHub:
When reporting an issue, include:
- Server version
- Skript Folia version
- Java version
- Installed addons
- Full error log
- Script that causes the issue
- Steps to reproduce the problem
Bug reports should be about Skript Folia itself. For help writing scripts, use community Skript resources.
Resources
Useful Skript resources:
- Skript Documentation:
- skUnity:
- SkriptHub:
- Original Skript project:
Skript Folia repository:
Contributing
Skript Folia is a Java plugin project based on Skript. Contributing requires Java experience and an understanding of Bukkit, Paper, and Folia server behavior.
Before contributing, review the source code, test changes on a Folia server, and make sure world, entity, player, and scheduler logic is Folia-safe.
Repository:
Summary
Skript Folia brings the familiar Skript scripting experience to Folia-based Minecraft servers.
It helps server owners create custom features faster while keeping the simplicity that made Skript popular: readable syntax, quick iteration, custom commands, reusable functions, and practical server automation.
For Folia networks that need custom behavior without building every feature as a full Java plugin, Skript Folia provides a flexible scripting layer built for modern server infrastructure.
评论 0
登录后参与评分
还没有评论,来抢沙发吧