Skip to content

Latest commit

 

History

History
72 lines (52 loc) · 2.27 KB

README.md

File metadata and controls

72 lines (52 loc) · 2.27 KB

FancySpawn Plugin for Minecraft

This plugin allows players to set a spawn point and teleport to it.

https://modrinth.com/plugin/fancysetspawn

Features

  • Set spawn: Players can set the spawn to their current position using the /setspawn command.
  • Teleport to spawn: Players can teleport to the spawn using the /spawn command.
  • Sound effects: The plugin plays sound effects during teleportation and spawn setting.
  • Configuration management: The plugin uses configuration files to manage messages and sounds.
  • API: The plugin provides an API for other plugins to interact with it.

Installation

  1. Download the plugin from GitHub.
  2. Place the plugin files into the plugins folder of your Minecraft server.
  3. Restart the server.

Usage

  • Set spawn: Use the /setspawn command.
  • Teleport to spawn: Use the /spawn command.

Configuration

The plugin configuration can be found in the config.yml file. Here you can modify messages and sound effects.

Configuration Examples

messages:
  spawnSet: "&aSpawn has been set to your current position!"
  teleportToSpawn: "&aYou have been teleported to the spawn!"
  spawnNotSet: "&cSpawn position is not set."
  commandOnlyPlayer: "&cThis command can only be used by players."
sounds:
  teleport: "minecraft:entity.experience_orb.pickup"
  setSpawn: "minecraft:entity.experience_orb.pickup"
  playerJoin: "minecraft:entity.player.levelup"
soundSettings:
  volume: 1.0
  pitch: 1.0

API Usage

The plugin provides a simple API for other plugins:

// Example usage of the API in another plugin
public void teleportToSpawn(Player player) {
    // Get the instance of the FancySpawn plugin
    SetSpawn plugin = (SetSpawn) getServer().getPluginManager().getPlugin("FancySetSpawn");
    
    if (plugin != null && plugin.isEnabled()) {
        // Get the API
        FancySpawnAPI api = plugin.getAPI();
        
        // Teleport the player to the spawn location
        api.teleportPlayerToSpawn(player);
    }
}

Available API Methods

  • getSpawnLocation() – Returns the spawn location
  • teleportPlayerToSpawn(Player) – Teleports the player to the spawn location
  • isSpawnSet() – Checks whether the spawn location is set