▄▄ ▄▄ ▄▄
███▀▀██▀▀███ ██ ▀███ ██ ▀███
█▀ ██ ▀█ ██ ██ ██
██ ▀███ ▄▄█▀██▀███▄███ ▄██▀██▄ ▄█▀▀███ ▄█▀██▄ ▄██▀████████▀██▀ ▀██▀ ██
██ ██ ▄█▀ ██ ██▀ ▀▀ ██▀ ▀██▄██ ██ ██ ██ ██▀ ██ ██ ██ ▄█ ██
██ ██ ██▀▀▀▀▀▀ ██ ██ █████ ██ ▄█████ ██ ██ ██ ▄█ ██
██ ██ ██▄ ▄ ██ ██▄ ▄██▀██ ██ ██ ██ ██▄ ▄ ██ ███ ██
▄████▄ ▄████▄ ▀█████▀████▄ ▀█████▀ ▀████▀███▄████▀██▄█████▀ ▀████ ▄█ ▄████▄
▄█
██▀
Heavily
ChatGPT-4
assisted development
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.
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 hisTF2 Dodgeball
servers if you're in the EU!
nodejs
14.x or laternpm
6.x or laterpterodactyl panel
1.xPHP
7.4 or laterComposer
(forPHP
)
This application is built in two parts:
- A
Node.js
application that fetches the servers from thePterodactyl
panel and updates them based on the hierarchy system.This can be run headless as a CLI tool or...
- 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.
Core Application
- Clone the repository.
$ git clone https://github.com/zodtf/tierodactyl.git
$ cd tierodactyl
- Install the
Node.js
dependencies.
$ npm install
- 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 asautoindex
enabled.
PTERODACTYL_API_KEY=your_pterodactyl_api_key
PTERODACTYL_PANEL_URL=https://your.pterodactyl.panel
HIERARCHY_MASTER_DIR=/path/to/your/hierarchy/master/dir
Pterodactyl Panel Addon
- Change to the
dactyl
directory.
$ cd tierodactyl/dactyl
- Install the PHP dependencies.
$ composer install
- Register the addon with the
Pterodactyl panel
by adding the addon's service provider to theproviders
array inconfig/app.php
.
TODO
WTF is this PHP shit?
@zudsniper
YourAddonNamespace\YourAddonServiceProvider::class,
- Publish the addon's assets.
$ php artisan vendor:publish --tag=your-addon-assets
- Run the core application to fetch the servers and update them based on the hierarchy system.
$ npm start
-
Log in to your Pterodactyl panel and navigate to the addon's route (e.g.,
/your-addon
). -
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. -
Use the addon's interface to perform other operations, such as viewing live terminal output, handling wildcards, and more.
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
This project is licensed under an ISC license. See the LICENSE file for more information.
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