Skip to content

zetsumi/FlyffAdminTool

Repository files navigation

Flyff Admin Tool

Disclaimer

FAT is under active development!

During this phase, I might have to publish updates that would break compatibility with older versions and some features might dramatically change over time. I'll do my best to take your feedback into account and will reduce breaking changes as much as possible...

But hey, change is a good thing, right? 😅

User guide

Requirements

This app only runs on 64 bits Windows 10 or 64 bits Windows Server 2016 and above systems.

Note: While FAT could run on older version of Windows, I won't test them nor provide support for any issue encountered on these configurations.

Features

Getting started with the Workflow Manager

The main feature of FAT consists in setting up a completely customizable Workflow where each node represents a command or file to execute:

  • Command or file path
  • Arguments
  • Delay

Start by editing your workflow to add some commands. Then, start/stop them all, sequentially up to a given node or individually.

You have full control over how you want to execute part or all of your Workflow! 😉

One started, you can monitor live metrics of your executables to make sure everything runs as expected. You'll also be able to interact with everything your executable communicates on:

  • Standard output (stdout)
  • Standard error (stderr)
  • Standard input (stdin)
  • Exit code

Everything the standard IO does, FAT does! 😍

Note: The executables started by FAT are attached to it. You must keep FAT running to maintain your server up as closing it closes its sub-processes as well.

Getting started with the System Dashboard

The System Dashboard provides a quick overview on your system information.

It will be improved over time to provide even more data! 👌

Getting started with the ODBC Wizzard

The ODBC Wizzard shows you the actual ODBC configuration of your system.

You'll be able to see the installed ODBC drivers as well as your DSNs and even test them! 👍

Developer guide

Requirements

This app is meant to be built and run on Windows systems only. Some calls to PowerShell make it unable to be built for other operating systems but this could be changed if a cross-platform way of managing ODBC systems is found in the future.

Flyff Admin Tool uses a Vue + Electron stack and relies on the Vue CLI Plugion Electron Builder plugin to wrap the VueJS app within an ElectronJS shell.

Development

This app is being developped using Visual Studio Code.

As for its frameworks and other tools, it uses:

Visual Studio Code extensions I use:

Install dependencies

The first thing to do when cloning a fresh copy of the project is to install its dependencies (as for any NodeJS project...)!

yarn install

Run

Using the following command builds the app in development mode and serves it locally.

yarn electron:serve

Build

The following command builds the app in production mode.

yarn electron:build

You can add the -p always option to publish it to GitHub. See this guide for more info.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages