Stope

This project adds a shared library for my mods, holding the code that breaks between Minecraft versions so each mod ports with less work.

模组 Fabric Forge 前置库

介绍

中文介绍正在准备中，下面暂时显示原文。

Stope

The chamber where the ore comes out.

Stope is a small library mod. It holds the code my mods share, along with the parts that
break whenever Minecraft updates, so each mod can be ported to new versions with less work.

Icon: “Mining” by Lorc, from game-icons.net, licensed under
CC BY 3.0. [Modified.]

For players

Install Stope when a mod you use lists it as a requirement. One copy serves every mod
that uses it. Launchers and modpack tools that read Modrinth dependencies add it for you.

Stope adds no blocks, items, textures, or settings, and changes nothing in your world on
its own. It only does something when a mod that uses it asks.

For mod developers

Stope’s public API lives in us.someguy.stope.api:

PlayerFootfallCallback: a server-side event when a player’s feet land on a block:
stepping onto a new block, or landing after being in the air. It never fires for jumping
over a block, elytra gliding, riding, or spectating.
PlayerMountFootfallCallback: the same event for a living mount, such as a horse,
while a player rides it. Boats and minecarts never fire it.
StopeSavedData: per-dimension saved data without the vanilla method that changes
between Minecraft versions.
DataReloaders: a server data-pack reload handler in one call.
VanillaBlocks: vanilla blocks under one stable name across renames, such as the
short grass plant.

New API starts as experimental and may change in a minor release. Stable API follows
semantic versioning.

Every release is on Modrinth’s Maven:

repositories {
    exclusiveContent {
        forRepository { maven { url = "https://api.modrinth.com/maven" } }
        filter { includeGroup "maven.modrinth" }
    }
}
dependencies {
    modImplementation "maven.modrinth:stope:<version>"
}

You may compile against Stope’s API and declare it as a dependency of your mod. Do not put
the Stope jar inside your mod’s jar; players install it separately. On Modrinth, mark Stope
as a required dependency.

Installation

Fabric 1.20.1: Stope and Fabric API, alongside the mod that needs Stope.
Forge 1.20.1: the same jar, plus Sinytra Connector and Forgified Fabric API.
Tested on Forge 47.4.28 with Connector 1.0.0-beta.49.

Stope runs on the server. Clients only need it when a mod built on it requires it there.

Modpacks

You’re welcome to include Stope in your modpack. No need to ask, as long as:

the pack is distributed on Modrinth or CurseForge, and references this project page rather
than bundling the jar wherever the platform allows;
the jar is unmodified;
the pack’s page credits Stope and links here; and
the pack is free.

For anything outside these terms, such as a paid pack, a paid mod, another platform, or a
modified jar, email [email protected].

Servers, videos, streams, and reviews are fine too, including monetized ones.