ToastAPI

A lightweight Minecraft plugin for displaying toast notifications across versions 1.19.4, 1.20.2, 1.20.4, 1.21, 1.21.4, 1.21.5

Versions Fully Tested

1.21.5, 1.21.4, 1.21.3, 1.21.1 1.20.6, 1.20.4, 1.20.2, 1.20.1

Features

• Simple toast notifications
• Multi-version support (1.21, 1.20.1)
• Commands: /toast <type> [message]
• Join event notifications
• Permission system

Installation

1. Download ToastAPI-1.0.0.jar
2. Place in your plugins/ folder
3. Restart server

Usage

/toast goal "Achievement unlocked!"
/toast task "Quest completed!"
/toast challenge "Boss defeated!"

Permissions

• toastapi.toast - Use /toast command
• toastapi.* - All permissions

For Developers

Want to use ToastAPI in your plugin? Follow these steps:

1. Build and Install ToastAPI Locally

First, clone and build ToastAPI:

git clone https://github.com/maximus-f/ToastsAPI.git
cd ToastsAPI
mvn clean install

This installs ToastAPI to your local Maven repository with:

• GroupId: com.frengor
• ArtifactId: toastapi
• Version: 1.0.0

📦 Note: ToastAPI uses a traditional distribution approach - we keep things simple and reliable by having you build from source and install locally. No complex remote repositories or dependency resolution headaches, just straightforward Maven installation that works every time.

2. Add as Dependency

Add ToastAPI to your plugin's pom.xml:

<dependencies>
    ... 
    <!-- ToastAPI (installed locally) -->
    <dependency>
        <groupId>com.frengor</groupId>
        <artifactId>toastapi</artifactId>
        <version>1.0.1</version>
    </dependency>
</dependencies>

3. Shade ToastAPI into Your Plugin

Use Maven Shade Plugin to include ToastAPI in your plugin:

<build>
    <plugins>
        <!-- Shade ToastAPI into your plugin jar -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>3.5.1</version>
            <configuration>
                <createDependencyReducedPom>false</createDependencyReducedPom>
                <minimizeJar>false</minimizeJar>
                
                <relocations>
                    <relocation>
                        <pattern>com.frengor.toastapi</pattern>
                        <shadedPattern>your.package.libs.com.frengor.toastapi</shadedPattern>
                    </relocation>
                </relocations>
                
                <artifactSet>
                    <includes>
                        <include>com.frengor:toastapi</include>
                    </includes>
                </artifactSet>
            </configuration>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>shade</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Basic Usage Example

import com.frengor.toastapi.ToastAPI;
import com.frengor.toastapi.AdvancementFrameType;
import org.bukkit.Material;

// Send a toast notification
ToastAPI.getInstance().sendToast(
    player,
    Material.DIAMOND,
    "Achievement Unlocked!",
    AdvancementFrameType.GOAL
);

Attribution

This project contains code derived from UltimateAdvancementAPI by fren_gor and EscanorTargaryen, licensed under LGPL v3. The NMS wrapper system and advancement handling code are based on this original work.

Original UAA Authors: fren_gor, EscanorTargaryen
Original Project: https://github.com/frengor/UltimateAdvancementAPI
Original License: LGPL-3.0

License

This project is licensed under the GNU General Public License v3.0 (same as the original UAA project).

See LICENSE file for the full LGPL v3 license terms.