https://github.com/joeyaurel/hytale-portals
Portal system for Hytale. Teleport to other worlds or points of interest.
https://github.com/joeyaurel/hytale-portals
hytale hytale-mod hytale-plugin
Last synced: 5 months ago
JSON representation
Portal system for Hytale. Teleport to other worlds or points of interest.
- Host: GitHub
- URL: https://github.com/joeyaurel/hytale-portals
- Owner: joeyaurel
- License: mit
- Created: 2026-01-18T16:43:48.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-01-26T22:25:28.000Z (5 months ago)
- Last Synced: 2026-01-27T01:05:45.663Z (5 months ago)
- Topics: hytale, hytale-mod, hytale-plugin
- Language: Java
- Homepage:
- Size: 74.9 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
## Getting Started
### Creating a Network
To start, you need to create a network that will house your portals:
- **Create:** `/portal network create `
- **List:** `/portal network list` (view all existing networks)
- **Remove:** `/portal network remove ` (Note: This also removes all portals within that network)
### Creating a Portal
1. **Initialize:** Run `/portal create ` 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
- `/portal network create `: Create a new network.
- `/portal network list`: List all existing networks.
- `/portal network edit `: Edit an existing network.
- `/portal network remove `: Delete a network and its portals. Has to be confirmed with an optional `--confirm` flag.
- `/portal network list`: List all portals within a specific network.
- `/portal create `: Begin the creation of a new portal.
- `/portal cancel`: Cancel the creation of a portal. (Uses the same permission as `/portal create `)
- `/portal done`: Finalize the portal and set its exit point. (Uses the same permission as `/portal create `)
## Contributing
I welcome contributions! Please refer to the [contributing guide](CONTRIBUTING.md) for more details.