Back to mods
Server API project artwork

Modrinth · Minecraft mod

Server API

A Server-Sided Mod API For Fabric

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

Quick answer

Which Server API release should I use?

Updated 2 years ago
Latest stable file 1.0.10+1.21.1
Game version 1.21.1
Loader Fabric

Server API 1.0.10+1.21.1 targets 1.21.1 with Fabric. Do not install it on the client. It must be installed on the dedicated server. No extra mods listed for this file.

Where it goes

Is Server API required on the client, server, or both?

Do not install it on the client. It must be installed on the dedicated server.

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

This file is marked server-only.

What else does Server API 1.0.10+1.21.1 need?

1.0.10+1.21.1. 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 Server API without breaking your instance.

Built for Server API 1.0.10+1.21.1. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use 1.0.10+1.21.1. It targets 1.21.1 with Fabric; 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

    Do not install it on the client. It must be installed on the dedicated server.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside 1.0.10+1.21.1. It opens that exact file at the source.

About this project

What does Server API add?

Fabric Server API

A server api for Fabric aiming to simplify server-side mods significantly.
With big goals of make server-sided fabric a much more stable and enjoyable
experience.

Hotkey Menu

  • Currently bound to Shift+F
  • DISABLED by default
    • Enable via the config file for ServerAPI

The hotkey menu currently just allows users to teleport to spawn. In the future it will allow MUCH more including configuration screens for other server-side mods, alternative type of TPA, trading, dueling, and many others.

To use the current "teleport to spawn" feature, admins must first set spawn in the menu via the "ADMIN" button on the top-right of it. This will require either the player be an OP, or that they have the serverapi.admin permission.

More features for the Hotkey Menu system in the coming months(hopefully).

Events

  • PlayerEvents.JUMP
    • A cancelable jump event for all ServerPlayerEntity
  • PlayerEvents.SNEAK
    • A cancelable sneak event for all ServerPlayerEntity
  • PlayerEvents.BLOCK_BREAK
    • A cancelable event for when a player breaks a block

ServerUtils

A utility class featuring a array of static methods for you to use!

  • Block getBlockByTag(Identifier);
  • ItemStack getHeadFromRaw(String rawId);
  • void setStackModelData(ItemStack, int); // For resource packs
  • void setStackLore(ItemStack, List<MutableText>);
  • MutableText getText(String, Formatting...);

ServerAPI

The "main" API to access... or at least thats the goal for the future. Limited use for now!

  • ServerPlayerEntity getPlayerByUUID(UUID, MinecraftServer);
  • ServerAPI.Logger
    • Gives a string infused with color attributes for you to log colored text to the console. Abusable so may be disabled by default in future versions via a config option?
    • String Success(String); // green color
    • String Warning(String); // yellow color
    • String Error(String); // Red color
    • String Debug (String); // cyan color

Future Goals - Further Out

  • A "ServerPlayer" class that would abstract a lot of the more
    "complex" things about dealing with server-sided fabric mods that
    interact directly with the Player class.
  • A lot more events.
  • Easier configuration file management for YOUR server-side mods!
  • Easily read/write from offline players.
  • GUI configuration management for your server-side mods.

Notice:
Bottles and all of its relations have been scrapped as a concept. Sorry for the hype!

Project description from Modrinth.

Pick your setup

Server API by Minecraft version and loader

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

9 available setups

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

Recent files

Server API versions and loaders

18 of 18 releases match

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