Lycorine

# Lycorine 

A easy way of making mods for minecraft servers.

## REQUIRED KNOWLEDGE

You *should* have a descent knowledge of JavaScript or TypeScript in order to develop plugins under Lycorine, unless you're simply a server owner trying to install some third-party 

JS plugins (If this is the case, test the plugin in a **safe environment** and have **backups** to ensure the script you're installing is safe.

As Lycorine Scripts have the same permission level as the other Java plugins you might have in your server.

## SETTING UP

Right now, tested minecraft versions are 1.18 to 1.21. Therefore setup a bukkit-based minecraft server in one of these versions.

If you need to use Lycorine in an earlier version- feel free to, and make sure to report any problems you find with the older versions

on my email at `miyuki@takina.jp.net`

### Installing Lycorine

Paste the plugin's jar file into your plugins folder, and the instalation will be completed after you either restart your server, or load the plugin

through a plugin manager plugin.

Here's a very basic explanation of what happens during server startup:

	- A directory named `LycorineScriptAPI` will be created inside of the plugins folder if it does not exist.

	- A file named `lycorine.d.ts` will be generated in that directory (no matter if it already exists or not).

	- Folders `data` and `scripts` will be created if does not exist inside of `LycorineScriptAPI`.

### About the "lycorine.d.ts" file and TypeScript support

If you have knowledge on TypeScript, you might have already noticed this file refers to [TypeScript](https://www.typescriptlang.org/) bindings for your scripts.

If you do end up using TypeScript in your scripts, ensure to have these settings in your tsconfig.json:

``` 

{

	"moduleResolution": "classic",

    "module": "None",

    "target": "ES2015",

}

```

## Writing Scripts

This article is located at [CODING_GUIDE.md](./CODING_GUIDE.md).

## FAQ

### But what about my modules?

Right now there is no proper module support, I do plan on supporting CommonJS modules in the future, but for now you'll have to stick with single-file scripts.

### Can I use async/await?

No, and this is server side code- you shouldn't even be thinking of async in the first place.

However, in a next release of Lycorine I'll provide implementations for `setInterval` and `clearTimeout` in case someone ends up needing a degree of "asynchronality".

But don't expect proper async support anytime soon unless there's a really good reason for me to implement proper async in.

### Certain API is missing from Lycorine!

If this is the case (and most likely is-) consider sending me an E-Mail at `miyuki@takina.jp.net` detailing the APIs that are missing, and what functionality should be expected.

The Minecraft API is huge, and every time I touch this project I try to port as much as possible.

### I removed a command from my script, but it still appears in autocompletion!

This is because Bukkit does not have an API to remove commands, I have to register commands as a wrapper object that actually invokes your JS function stored in another object.

This is why you can still change and create commands after editing a script and running `/lycorine reload`.

If you want to know how this wrapper object works, see [JSCommand.java](https://takina.jp.net/projects/lycorine-api/tree/view/src/main/java/jp/net/takina/lycorine/bound/command/JSCommand.java)