Skip to content

Getting Started

What is Actor

Actor is an API that allows you to script Player Interactions like Movement, Block Placing, etc. all while ensuring that the behaviour stays compatible with Servers (meaning that Actor adheres to limitations on the client side).

Therefore Actor is the optimal library to use when you want to write deterministic TAS tools or other mods where you want the player to behave "like normal", while having full programmatic control.

New to modding?

If you are new to Minecraft modding, follow your loader's basic setup guide first.

About the Documentation

The Docs will help you set up Actor and write your first simple control script.
This will also be useful if you're looking for a specific feature in the future or don't remember how to do a certain thing.
If you're too lazy to read everything you can also skip sections, or paste this link into the LLM provider of your choice and ask them to summarize the contents.

What you will do

  • Add Actor to your dev environment
  • Attach an Actor to a Player
  • Automate actions via the Actor API

Supported Environments

Actor generally supports every major Mod Loader (Fabric, Quilt, Forge and NeoForge) and mapping setups.

Contributing

Actor is open source, so if you have any trouble or issues using it, feel free to open an Issue on the GitHub Page.
If you have an idea that could improve Actor you can at any time fork the Repo and submit a pull request.
You may also just open an Issue and propose a new idea there.

Sources

The Documentation uses VitePress.
The Mod itself uses this Multiloader Template from mctemplates.net.