Skip to content

Latest commit

 

History

History
183 lines (128 loc) · 6.1 KB

Installation.md

File metadata and controls

183 lines (128 loc) · 6.1 KB
title description published date tags editor dateCreated
Installation
Getting Started with IridiumSkyblock
true
2024-02-18 15:15:45 UTC
markdown
2023-03-29 15:34:46 UTC

Requirements

IridiumSkyblock requires the following to load:

  • Spigot, or one of its forks, for Minecraft version 1.13 or later.
  • Vault.

 

Recommendations

While these plugins are not mandatory for IridiumSkyblock to load, they add functionality that is considered essential on most servers.

  • A Spawn Plugin (For providing a way to return to the default world).
  • An Economy Plugin that supports Vault (Required for any currency to be used or rewarded).
  • Placeholder API (PAPI) (For placeholders to function across other plugins).
  • World Edit (For making schematics).

 

We recommend using 1.16+, as previous versions have performance issues and lack features. We also recommend using Paper or Purpur.

If you are not running a version listed above, either update your server or do not use IridiumSkyblock, as it will not work properly. {.is-info}

Note: IridiumSkyblock currently does NOT support Folia. It will not load on any server using this software. {.is-warning}

 

Installation Steps

  1. Download the plugin from Spigot or Modrinth.
  2. Place the downloaded file in your server/plugins folder.
  3. Restart your server by running stop in the console and allowing the server to fully shutdown, then start the server again.

Do NOT use the /reload command, or any plugin that reloads your server or plugins, like PlugManX. This breaks the way that IridiumSkyblock (and many other plugins) functions, and can cause data loss. You will not receive support for this plugin if you are using these methods. {.is-danger}

After that, IridiumSkyblock should populate your server/plugins/IridiumSkyblock folder with all the files it needs to work properly. {.is-success}

 

You should see the following in plugins/IridiumSkyblock:

Config files (.yml)
  • bankitems.yml
  • biomes.yml
  • blockvalues.yml
  • commands.yml
  • configuration.yml
  • enhancements.yml
  • inventories.yml
  • messages.yml
  • missions.yml
  • permissions.yml
  • schematics.yml
  • settings.yml
  • shop.yml
  • sql.yml
  • top.yml
Database file (.db)
  • IridiumSkyblock.db
Schematic files (.schem)
  • IridiumSkyblock/schematics
    • desert.schem
    • desert_end.schem
    • desert_nether.schem
    • jungle.schem
    • jungle_end.schem
    • jungle_nether.schem
    • mushroom.schem
    • mushroom_end.schem
    • mushroom_nether.schem

You can also confirm that IridiumSkyblock loaded by running /is about or by searching your console log for the message that IridiumSkyblock sends when it's enabled.

A screenshot of the /is about command.

A screenshot of the /is about command. Your message may have a different version listed.

As you can see in the example image, IridiumSkyblock has loaded and is working properly.

 

If you do not see this, but instead an error or unknown command prompt, please make sure that you have Vault installed, and that you're running a supported version of Minecraft and Spigot (or its forks). The plugin will either show up in red when using /plugins (/pl) or it will not show up at all, and there will be an error in the console explaining the problem.

Example:

[19:36:49 ERROR]: Could not load 'plugins\IridiumSkyblock-4.0.jar' in 'plugins'

org.bukkit.plugin.UnknownDependencyException: Unknown/missing dependency plugins: [Vault]. Please download and install these plugins to run 'IridiumSkyblock'. {.is-danger}

If you see this error, that means that you do not have Vault installed. Please download and install Vault to run IridiumSkyblock.

 

Supported Plugins / Extra Features

These plugins are supported by IridiumSkyblock, and installing them will provide your server with extra features not otherwise implemented into the main plugin.

Please note that IridiumDevelopment will not be able to provide support for plugins outside the IridiumDevelopment family, but we're more than happy to try and point you in the right direction.

You should probably ask for support from the developers.

 

Supported Plugins

World / Schematic Generation
Placeholders
Spawners / Stackers
Economy

You can use any economy plugin that hooks into Vault, but we recommend one of these.

Other Placeholder Text

Note: If you'd like to see your plugin listed here, let us know in our Discord server! (Read the rules first, though.) {.is-info}

 

Uninstall

In order to properly uninstall IridiumSkyblock from your server, follow these steps.

  1. Stop the server.
  2. Delete the plugins/IridiumSkyblock folder.
  3. Delete the IridiumSkyblock world folder.
  4. Delete the plugin file from plugins.
  5. Start the server.