Inexor Flex is platform for managing Inexor Core instances and the Inexor Tree API and provides a scripting environment for servers and clients. Inexor Flex also makes multiple user interfaces using web technologies available.
Hello there and welcome to the inexor-flex documentation!
Now, you're wondering what inexor-flex actually is, and what it does?
but this tree was hard to access. It's sent over the wire in a compressed format, that's hard to work with for "casual users"
next: we created inexor-flex. It makes this tree available via a web service (and webviewer). On your local computer.
You can choose from one of our graphical installers at our website.
you need to have Node.js installed from nodejs.org. The latest stable release is recommended.
NOTE: If you're curious what the graphical installer does. No suprise. Exactly the same.
Since nowadays, all configuration is done via inexor-flex, we have introduced a system called instances. Each Inexor client or server is an instance. You can have multiple clients (or servers), with different configurations, even running different versions of the game. No problemo.
Now let's go fancy. Right at your browser.
If you want to be little bit more of a power user, we also ship a graphical interface for flex. Right there. When you download it.
To set up inexor-flex follow the below instructions.
inexor-flex brings a verbose command line that can easily be accessed with it's name. Just call inexor-flex from your command line (shell, prompt, terminal), and you can have a lot of options to configure flex from the command line.
server is where the actual flex server resides. The web server is started here, and all run-time functionality (such as paths) are determined here.
All of the above components are wired together using the Application Context module.
After the "wire" individual components, such as the package manager are started.
The API is exposed as a RESTfull API.
inexor-flex was initially born to serve the tree of inexor-core and this is how it works nowadays.
You can then use the interfaces command line to add your newly written.
We use JSDoc for documentation. All modules from src and server are automatically added to the documentation, when following the standards.
We endorse the eslint:recommended rule set, combined with some custom rules. You can make sure your module matches our standard by running npm run lint in the main directory.
We also try to apply the changes detected by the [security/recommended] standard.
The REST API (v1) is wired together in server/api/v1/index.js Documentation via swagger should follow soon enough.
You can have a look at the src/types module, for a very simple and basic module example.
We have specifically designed the module @inexorgame/treeclient to work with the v1 API. You can have a look at one of the many command-line tasks in server/commands/cli/ which will give a fine example on how to use the treeclient library.
npm unlink @inexorgame && npm un -g @inexorgame/inexor-flex rm -rf node_modules And then install again.