mirror of
https://github.com/NATroutter/egg-hytale.git
synced 2026-03-01 11:21:13 +03:00
init
This commit is contained in:
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2023 egg-hytale
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
114
README.md
Normal file
114
README.md
Normal file
@@ -0,0 +1,114 @@
|
||||
# Hytale Server Egg
|
||||
|
||||
 
|
||||
 
|
||||
|
||||
A Pelican Panel egg for hosting Hytale game servers.
|
||||
|
||||
## Overview
|
||||
|
||||
This egg provides an automated installation and startup configuration for Hytale servers on Pelican Panel. It handles downloading the Hytale server files, setting up the environment, and starting the server with customizable parameters.
|
||||
|
||||
**Note**: While designed for Pelican Panel, this egg should work with Pterodactyl Panel as well, though it has not been tested on Pterodactyl.
|
||||
|
||||
## Features
|
||||
|
||||
- Automated Hytale server installation
|
||||
- Automatic download of server files from official sources
|
||||
- Configurable server parameters
|
||||
- Easy setup and deployment
|
||||
- Support for custom asset packs
|
||||
- Backup management
|
||||
- Multiple authentication modes
|
||||
|
||||
## Installation
|
||||
|
||||
1. Download the `egg-hytale.json` file from this repository
|
||||
2. In your Pelican Panel, navigate to **Admin Panel** > **Eggs**
|
||||
3. Click **Import**
|
||||
4. Select the downloaded JSON file
|
||||
5. Configure the egg settings as needed
|
||||
|
||||
For Pterodactyl Panel users, the process should be similar, though compatibility is untested.
|
||||
|
||||
## Server Configuration
|
||||
|
||||
The following variables can be configured:
|
||||
|
||||
| Variable | Description | Default |
|
||||
|----------|-------------|---------|
|
||||
| `ASSET_PACK` | Asset pack to use | `Assets.zip` |
|
||||
| `ACCEPT_EARLY_PLUGINS` | Accept early-access plugins | `false` |
|
||||
| `ALLOW_OP` | Allow operator privileges | `true` |
|
||||
| `AUTH_MODE` | Authentication mode | `authenticated` |
|
||||
| `ENABLE_BACKUPS` | Enable automatic backups | `false` |
|
||||
| `BACKUP_DIRECTORY` | Backup directory path | `./backups` |
|
||||
| `BACKUP_FREQUENCY` | Backup frequency in minutes | `30` |
|
||||
| `SERVER_IP` | Server bind IP address | `0.0.0.0` |
|
||||
| `SERVER_PORT` | Server port | `5520` |
|
||||
|
||||
|
||||
## Scripts
|
||||
|
||||
### install.sh
|
||||
|
||||
Handles the initial installation of the Hytale server:
|
||||
- Installs required dependencies (curl, unzip)
|
||||
- Downloads the Hytale downloader
|
||||
- Extracts server files
|
||||
- Downloads the start script from GitHub
|
||||
- Sets executable permissions
|
||||
- Runs initial server setup
|
||||
|
||||
### start.sh
|
||||
|
||||
Manages server startup:
|
||||
- Verifies Hytale downloader exists
|
||||
- Sets executable permissions if needed
|
||||
- Runs the Hytale downloader
|
||||
- Starts the Hytale server with configured parameters
|
||||
|
||||
## Usage
|
||||
|
||||
Once installed, simply start the server from your Pelican Panel. The egg will handle:
|
||||
1. Running the Hytale downloader to fetch the latest server files
|
||||
2. Starting the server with your configured parameters
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please feel free to submit a Pull Request.
|
||||
|
||||
1. Fork the repository
|
||||
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
|
||||
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
|
||||
4. Push to the branch (`git push origin feature/AmazingFeature`)
|
||||
5. Open a Pull Request
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see the LICENSE file for details.
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
- Hytale team for the game and server software
|
||||
- Pelican Panel for the hosting platform
|
||||
- Community contributors
|
||||
|
||||
## Links
|
||||
|
||||
- [Hytale Official Website](https://hytale.com/)
|
||||
- [Pelican Panel](https://pelican.dev/)
|
||||
- [Pterodactyl Panel](https://pterodactyl.io/) (untested compatibility)
|
||||
- [Report Issues](https://github.com/NATroutter/egg-hytale/issues)
|
||||
|
||||
## Support
|
||||
|
||||
If you encounter any issues or have questions:
|
||||
- Open an issue on GitHub
|
||||
- Check existing issues for solutions
|
||||
- Review the troubleshooting section above
|
||||
|
||||
---
|
||||
|
||||
**Note**: This is an unofficial community-created egg and is not officially supported by Hypixel Studios or the Hytale team.
|
||||
139
egg-hytale.json
Normal file
139
egg-hytale.json
Normal file
File diff suppressed because one or more lines are too long
31
start.sh
Normal file
31
start.sh
Normal file
@@ -0,0 +1,31 @@
|
||||
#!/bin/bash
|
||||
|
||||
DOWNLOADER="./hytale-downloader-linux-amd64"
|
||||
|
||||
# Check if the downloader exists
|
||||
if [ ! -f "$DOWNLOADER" ]; then
|
||||
echo "Error: Hytale downloader not found!"
|
||||
echo "Please run the installation script first."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check if the downloader is executable
|
||||
if [ ! -x "$DOWNLOADER" ]; then
|
||||
echo "Setting executable permissions..."
|
||||
chmod +x "$DOWNLOADER"
|
||||
fi
|
||||
|
||||
echo "Starting Hytale downloader..."
|
||||
$DOWNLOADER -check-update
|
||||
$DOWNLOADER
|
||||
|
||||
echo "Starting Hytale server..."
|
||||
java -jar HytaleServer.jar \
|
||||
--assets {{ASSET_PACK}} \
|
||||
--accept-early-plugins {{ACCEPT_EARLY_PLUGINS}} \
|
||||
--allow-op {{ALLOW_OP}} \
|
||||
--auth-mode {{AUTH_MODE}} \
|
||||
--backup {{ENABLE_BACKUPS}} \
|
||||
--backup-dir {{BACKUP_DIRECTORY}} \
|
||||
--backup-frequency {{BACKUP_FREQUENCY}} \
|
||||
--bind {{SERVER_IP}}:{{SERVER_PORT}}
|
||||
Reference in New Issue
Block a user