Sloud Hytale Portals

A comprehensive portal system for Hytale, allowing players to teleport between worlds or specific points of interest.

⚠️ Warning: Early Access
Both Hytale and this project are in early access. Features may be incomplete, unstable, or subject to frequent changes. We appreciate your patience and understanding as development progresses.

Features

• Portal Networks: Portals are organized into networks. A network requires at least two portals to function.
• Seamless Teleportation: Stepping through a portal teleports you to another portal within the same network.
• Destination Selection: If a network contains more than two portals, players can choose their specific destination via an interactive menu.

Installation

• Download the latest JAR file from the here. (The current version is: v0.5.0)
• Put the JAR file in your Hytale mods folder.

Getting Started

Creating a Network

To start, you need to create a network that will house your portals:

• Create: /portal network create <name>
• List: /portal network list (view all existing networks)
• Remove: /portal network remove <network-name> (Note: This also removes all portals within that network)

Creating a Portal

1. Initialize: Run /portal create <portal-name> to start the portal creation process.
2. Select Network: Choose the network the portal should belong to.
3. Name It: Provide a unique name for your portal.
4. Define Bounds: Touch two blocks to define the portal's physical area. (Note: These blocks cannot be destroyed until the creation is finished).
5. Set Destination: Stand at the desired exit point, face the direction you want players to arrive at, and run /portal done.

Commands and their Permissions

Command	Description	Permission
/portal	Show usage of this command and subcommands. (Most commands have aliases.)	None.
/portal create <portal-name>	Begin the creation of a new portal.	sloud.portals.portal.create
/portal done	Finalize the portal and set its exit point.	sloud.portals.portal.create
/portal cancel	Cancel the creation of a portal.	sloud.portals.portal.create
/portal remove <portal-name>	Delete an existing portal. Has to be confirmed with a --confirm.	sloud.portals.portal.delete
/portal network create	Create a new network.	sloud.portals.network.create
/portal network list	List all existing networks.	sloud.portals.network.list
/portal network edit <network-name>	Edit an existing network.	sloud.portals.network.update
/portal network remove <network-name>	Delete a network and its portals. Has to be confirmed with a --confirm.	sloud.portals.network.delete
/portal config reload	Reload the plugin configuration.	sloud.portals.admin

For Developers: Maven/Gradle

This project is published to Maven Central, so you can also add it as a dependency in your project using Maven or Gradle. It is also available on GitHub Packages within this repository.

Important

Project is also published on GitHub Packages. Under https://github.com/sloud/hytale-portals/packages/ you can find packages for Maven and Gradle.

To use them, you should read the following:

• "Working with the Apache Maven registry" when using Maven.
• "Working with the Gradle registry" when using Gradle.

To add it to your Maven project, include the following dependency in your pom.xml:

<dependency>
  <groupId>network.sloud.hytale</groupId>
  <artifactId>portals</artifactId>
  <version>0.5.0</version>
</dependency>

To add it to your Gradle project, include the following dependency in your build.gradle:

// Add the Maven Central repository to your build file, if you want to use it instead of GitHub Packages
repositories {
    mavenCentral()
}

dependencies {
    implementation 'network.sloud.hytale:portals:0.5.0'
}

Contributing

I welcome contributions! Please refer to the contributing guide for more details.