Back to mods
SheepScriptLib project artwork

CurseForge · Minecraft mod

SheepScriptLib

Based on CustomNpcs, it provides some useful tools.

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which SheepScriptLib release should I use?

Updated 1 year ago
Latest stable file [1.12.2]SheepScriptLib-1.25.1.jar
Game version 1.12.2
Loader Forge

SheepScriptLib [1.12.2]SheepScriptLib-1.25.1.jar targets 1.12.2 with Forge. The project page does not say whether this file belongs on the client, dedicated server, or both. No extra mods listed for this file.

Where it goes

Is SheepScriptLib required on the client, server, or both?

The project page does not say whether this file belongs on the client, dedicated server, or both.

Client Source doesn’t say
Dedicated server Source doesn’t say
Loader for this release Forge
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

The source does not explicitly classify this release as client-only or server-only.

What else does SheepScriptLib [1.12.2]SheepScriptLib-1.25.1.jar need?

[1.12.2]SheepScriptLib-1.25.1.jar. Change the file and its required mods may change too.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

This file does not list any required or optional mods.

Before you install it

Add SheepScriptLib without breaking your instance.

Built for SheepScriptLib [1.12.2]SheepScriptLib-1.25.1.jar. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use [1.12.2]SheepScriptLib-1.25.1.jar. It targets 1.12.2 with Forge; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    The project page does not say whether this file belongs on the client, dedicated server, or both.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside [1.12.2]SheepScriptLib-1.25.1.jar. It opens that exact file at the source.

About this project

What does SheepScriptLib add?

The detail of API will provided later.

Functions

BetterCloneHandler:

Provides clones' caches, instead of CNPC's real-time IO, it will be fast.

SheepAI:

Implement class: saltsheep.ssl.api.SheepAI, saltsheep.ssl.api.SheepAIHandler

new AI and inputs: owner IEntity, whetherShouldRun(IEntity)=>boolean, run(IEntity)=>void,endedRun(IEntity)=>void, canStopDefault boolean

use SheepAIHandler to add ai to a ai group.

SheepAI is working based on async thread, and use waitTick(int) to wait in the thread then use work(()=>void) to run in the server thread, it is well designed to have a great efficiency.

Task:

A light function that provides task chain and delay work.

Use like: Task.run(function(){}).append(Task.delay(10)).append(Task.run(function(){})).start();

Also can be hignly customed, use Task.custom(runnable init, Callable<boolean> invoke, Callable<Task> clone), and it will ended when invoke return true or server stopped.

NeoPuppet:

This function based on the edit of JobPuppet, the mod use ASM to append extra logic on JobPuppet getRotation method.

It is too complex to explain, it is better to see in saltsheep.ssl.api.neo.AnimationHandler, saltsheep.ssl.api.neo.AnimationNode.

It will be easy.

BothSideScript:

It provides a chance to use script in both server and client, and you can switch it.

It may be a bit dangerous for the server owner because I set no limit for the script. My meaning is, player can cheat by using it, because it works like a mod.

The only way to avoid it completely is to delete the function.

Using it:

the files with suffix ".ssl.js" under directory .minecraft\SheepBothScripts, which contains its sub directory, will be loaded by eval.

the scripts will defaultly have two extra global variable: station and script

script: saltsheep.ssl.script.ScriptContainer, set the container name, hook events(FMLEvents will have special implement)

station: saltsheep.ssl.api.Common.station, a javascript object stored at Java layer, you can use it to achieve the connection of scripts.

But it didnt provide any client's wrapper API, which like CNPC's API, for you.

The more:

There's many scattered functions under saltsheep.ssl.api, you can discover it by yourself.

Dependencies

SheepKeyLib, CustomNpcs

Project description from CurseForge.

Pick your setup

SheepScriptLib by Minecraft version and loader

Choose the version and loader you play, then open the matching release.

1 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

SheepScriptLib versions and loaders

7 of 7 releases match

Looking for an older file? The official CurseForge project page is in Resources.