Ferret

Free and open source Minecraft mod with Lua scripting API

Lua API https://cattyn.gitbook.io/ferret-lua-api/

Discord https://discord.gg/dbH47Pg4Mf

Building

To build Ferret you need to have JDK 17 installed

Download Ferret source code by clicking Code -> Download ZIP on the main page
Extract the source code somewhere and open cmd (on Windows) or Terminal
Type gradlew build (if you're on Windows) or chmod +x ./gradlew && ./gradlew build (if you're on Linux) and wait until the building process finishes
After that you should have a file called Ferret-0.0.1.jar inside <ferret src>/build/libs folder
Put it inside .minecraft/mods folder and start the game

Downloading

You can download stable prebuilt JARs from the releases page

Unstable prebuilt JARs are available on our GitHub Actions page, but you need to have a GitHub account to access them

Please note that Ferret requires Fabric API to be installed

Usage

Download Ferret scripts from here and put them into your .minecraft/ferret/scripts folder

The default command prefix is . . You can change it by typing .setprefix "<prefix>"

Credits

Cattyn - lead developer
ZimnyCat - second lead developer
mrnv - yarn remapper and mixins support
LuaJ - lua interpreter

License (MIT)

Copyright 2022 cattyn!

Permission is hereby granted, free of charge,
to any person obtaining a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice
shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

also dont sell your scripts

cattyngmd / Ferret