FilesEngine (fe-tools)

FilesEngine is a simple tool designed to create 2D games. It's mostly a tool for creating games.

Features

• Files Engine use java 21.
• This engine use LWJGL library.
• Files Engine also have a custom ECS (Entity Component System) with division into components and scripts.
• Each component has its own script class with name <CompName>Scripts.

Getting Started

To get started with FilesEngine, download this repository and create an artifact with main class App. if you want for test start just run .jar file. But if you want to run scene redactor start with arg SM or scene-manager. For example: java -jar out/artifacts/ur_artifact/fe-tools.jar SM.

Mini-Documentation

How to create custom script

1. Create script in src/main/java.
2. Add extends FilesScripts to your script class.
3. Override start() & update(float dt) methods.
4. In file assets/scripts.json write in SCRs your script link example: (com.example.UrScript).

You can see test script here: src/main/java/testscrgl.java.

How to add any component to auto update

1. Write scripts class of your component in file assets/scripts.json in Comps.
2. That's all!

How to compile

1. Type in terminal git clone https://github.com/adisteyf/fe-tools.git.
2. Type in terminal mvn clean install in root project (where is pom.xml).
3. Run target/FilesEngine-<ver>-jar-with-dependencies.jar.

License

This project is licensed under the MIT License - see the LICENSE file for details.