▄▄                                  ▄▄                                   ▄▄  
███▀▀██▀▀███ ██                                ▀███                  ██             ▀███  
█▀   ██   ▀█                                     ██                  ██               ██  
     ██    ▀███   ▄▄█▀██▀███▄███  ▄██▀██▄   ▄█▀▀███  ▄█▀██▄  ▄██▀████████▀██▀   ▀██▀  ██  
     ██      ██  ▄█▀   ██ ██▀ ▀▀ ██▀   ▀██▄██    ██ ██   ██ ██▀  ██  ██    ██   ▄█    ██  
     ██      ██  ██▀▀▀▀▀▀ ██     ██     █████    ██  ▄█████ ██       ██     ██ ▄█     ██  
     ██      ██  ██▄    ▄ ██     ██▄   ▄██▀██    ██ ██   ██ ██▄    ▄ ██      ███      ██  
   ▄████▄  ▄████▄ ▀█████▀████▄    ▀█████▀  ▀████▀███▄████▀██▄█████▀  ▀████   ▄█     ▄████▄
                                                                           ▄█             
                                                                         ██▀              

WARNING: This project is still in development and is not yet ready for ANY use.

Heavily ChatGPT-4 assisted development

---

🥉🥈🥇 Tierodactyl 🥇🥈🥉

Pterodactyl Hierarchy Update System

This project consists of a Node.js application for managing server file updates based on a hierarchical external id system and a Pterodactyl addon for interfacing with the core application. The application can be run headless as a CLI tool or integrated with the Pterodactyl panel using the provided addon.

💡 Inspiration & Motivation

I was lazy and needed a tool to automate the process of updating my servers. I'm not sure how many times I'll have to use this tool to justify the time I spent making it, but I'm sure I'll find a use for it eventually...

THEN I also made the acquaintance of @Tolfx by making him a Cheeto Beard (C:)
He's an extremely intelligent dude, and his @father-tf/UpdateManager project is the inspiration for this project, if there is one.
Go check out his work, or his TF2 Dodgeball servers if you're in the EU!

@zudsniper

---

📦 Prerequisites

• nodejs 14.x or later
• npm 6.x or later
• pterodactyl panel 1.x
• PHP 7.4 or later
• Composer (for PHP)

---

🧫 Overview

This application is built in two parts:

1. A Node.js application that fetches the servers from the Pterodactyl panel and updates them based on the hierarchy system.

   This can be run headless as a CLI tool or...

2. A Pterodactyl addon that provides an interface for the core application.

   This addon can be installed on the Pterodactyl panel and used to manage the servers.

---

🥚 Installation

A. TieroCore

Core Application

1. Clone the repository.

$ git clone https://github.com/zodtf/tierodactyl.git
$ cd tierodactyl

2. Install the Node.js dependencies.

$ npm install

3. Create a .env file in the root directory of the project and configure the required environment variables.

Note: The HIERARCHY_MASTER_DIR value should be the path to the directory containing the hierarchy files. It does NOT however need to be a local directory. It can be a remote directory, so long as that directory as autoindex enabled.

PTERODACTYL_API_KEY=your_pterodactyl_api_key
PTERODACTYL_PANEL_URL=https://your.pterodactyl.panel
HIERARCHY_MASTER_DIR=/path/to/your/hierarchy/master/dir

---

B. Dactyl

Pterodactyl Panel Addon

1. Change to the dactyl directory.

$ cd tierodactyl/dactyl

2. Install the PHP dependencies.

$ composer install

3. Register the addon with the Pterodactyl panel by adding the addon's service provider to the providers array in config/app.php.

TODO WTF is this PHP shit?
@zudsniper

YourAddonNamespace\YourAddonServiceProvider::class,

4. Publish the addon's assets.

$ php artisan vendor:publish --tag=your-addon-assets

---

🍳 Usage

Running the Core Application as a CLI Tool

1. Run the core application to fetch the servers and update them based on the hierarchy system.

$ npm start

Using the Pterodactyl Addon

1. Log in to your Pterodactyl panel and navigate to the addon's route (e.g., /your-addon).

2. Set the HIERARCHY_MASTER_DIR value in the input field and click the "Update Servers" button to update the server files according to the hierarchy system.

3. Use the addon's interface to perform other operations, such as viewing live terminal output, handling wildcards, and more.

🧽 Testing

This section is HEAVILY under construction.

This project includes unit and integration tests using Jest. To run the tests, execute the following command:

$ npm test

License

This project is licensed under an ISC license. See the LICENSE file for more information.

---

$FIN$!

Thanks for making it to the end of this README.

---

zod.tf

fullstack development, server administration, web design, branding creation, musical composition & performance, video editing, and more probably