Inexor Reactive Graph Flow
[
](https://inexorgame.github.io/inexor-rgf-application/book/)
[
](https://inexorgame.github.io/inexor-rgf-application/docs/)
[
](https://www.rust-lang.org/)
[
]()
[
](https://github.com/inexorgame/inexor-rgf-plugins/blob/main/LICENSE)
[![Build](https://github.com/inexorgame/inexor-rgf-plugins/actions/workflows/rust.yml/badge.svg)](https://github.com/inexorgame/inexor-rgf-plugins/actions/workflows/rust.yml)
[![Formatting](https://github.com/inexorgame/inexor-rgf-plugins/actions/workflows/fmt.yml/badge.svg)](https://github.com/inexorgame/inexor-rgf-plugins/actions/workflows/fmt.yml)
[![Clippy](https://github.com/inexorgame/inexor-rgf-plugins/actions/workflows/lint.yml/badge.svg)](https://github.com/inexorgame/inexor-rgf-plugins/actions/workflows/lint.yml)
[
](https://app.codecov.io/gh/inexorgame/inexor-rgf-plugins)
[
](https://discord.com/invite/acUW8k7)
List of Plugins
In this repository you'll find the essential plugins which are necessary or useful for all use cases.
| Name | Description |
|-----------------------------------------------------------------------------------|--------------------------------------------|
| [Arithmetic](./plugins/arithmetic/README.md) | Provides arithmetic gates and operations |
| [Base](./plugins/base/README.md) | Provides basic components and entity types |
| [Binary](./plugins/binary/README.md) | Handles binary data |
| [Color](./plugins/color/README.md) | Colors and colorspace transformations |
| [Comparison](./plugins/comparison/README.md) | Provides comparison gates |
| [Config](./plugins/config/README.md) | Load configuration files |
| [Connector](./plugins/connector/README.md) | Provides property connectors |
| [Date Time](./plugins/date-time/README.md) | Date and Time, Durations and calculation |
| [File](./plugins/file/README.md) | File representation |
| [Git](./plugins/git/README.md) | Git VCS operations |
| [GraphQL Client](./plugins/graphql-client/README.md) | GraphQL client |
| [GraphQL Schema Visualization](./plugins/graphql-schema-visualization/README.md) | Visualization of the GraphQL schema |
| [HTTP](./plugins/http/README.md) | HTTP and JSONRPC |
| [JSON](./plugins/json/README.md) | Handles JSON arrays and objects |
| [Logical](./plugins/logical/README.md) | Provides logical operations |
| [Meta Data](./plugins/metadata/README.md) | Meta Data - Dublin Core, EXIF |
| [Numeric](./plugins/numeric/README.md) | Numeric operations |
| [Random](./plugins/random/README.md) | Generate random numbers |
| [Result](./plugins/result/README.md) | Result components |
| [State](./plugins/state/README.md) | Debounced states |
| [String](./plugins/string/README.md) | Provides string operations |
| [System Environment](./plugins/system-environment/README.md) | Provides environment variables |
| [Taxonomy](./plugins/taxonomy/README.md) | Taxonomy - categories and tags |
| [Trigger](./plugins/trigger/README.md) | Triggers and actions |
| [Value](./plugins/value/README.md) | Values and state management |
Local Build + Local Deployment
#### Setup deployment directory in `.deployment.toml`
```shell
target_dirs = [
"../inexor-rgf-application/plugins/deploy"
]
```
#### Install a specific plugin
```shell
cargo build
cargo post build --package=inexor-rgf-plugin-date-time
```
#### Install all plugins of this repository at once
```shell
cargo build
cargo post build --package=deployment-all
```
What is this?
➔ The `Reactive Graph Flow` is a **graph database**
➔ The `Reactive Graph Flow` is a **document store**
➔ The `Reactive Graph Flow` is a **flow control** runtime
➔ The `Reactive Graph Flow` is a **web server**
➔ The `Reactive Graph Flow` is **pluggable** and **extensible**
➔ The `Reactive Graph Flow` is **fast**, **secure** and **small**
What is it for?
➔ Game Entity Component System (ECS) - especially for [Inexor](https://inexor.org/)
➔ Smart Home and Internet of Things
➔ Data Conversion Tools
➔ Flow Control System for card size computers and embedded devices
➔ Desktop Automation
➔ Content Management System
➔ Knowledge Graphs and Knowledge Processing
Graph
A **graph** organizes highly interconnected data. The state of an `Entity Component System` can be ideally represented
with the help of the graph. Inexor is the first game engine to introduce a graph as a basis.
The main benefits of a graph are:
* A universal data structure for everything
* Relations are first class citizens
* Benefit from types and instances which makes things intuitive
* Benefit from navigation which is fast and intuitive
* Benefit from the semantics of highly connected, intuitive data
* Properties can store not only certain primitive data but complete documents
Reactive
Now that we understand how data is stored, here's how data interacts. The approach is that the data itself is "alive".
To do this, Inexor adopts a concept from reactive programming.
In computing, reactive programming is a declarative programming paradigm concerned with data streams and the
propagation of change.
It is the ingenious combination of a graph with reactive programming. The property instances are not static
and only contain data. Rather, they are streams of data. If you change the value of a property instance, you
fill the data stream of this property instance. Data streams are linked together. For example, if the stream
of one property instance is linked to the stream of another property instance and you change the value of the
first property instance, the value of the second property instance will automatically change as well. Data is
thus propagated from one station to the next, triggering a cascade of propagations.
In addition, Inexor remembers the last value in each property instance. This is done by subscribing to your
own data stream and caching it. This allows subsequent querying of the value of a property instance.
Remember this basic concept:
* Every property is a stream not only data
* Property streams can be subscribed and published
* The streams of two properties can be connected and changes will be propagated (cascade)
Behaviour driven design
The data flow is therefore automatic. Building on this, Inexor applies the concept of behaviour-driven design.
The goal is to use these data streams to simulate behaviour.
Behaviors can be implemented on components, entities and relations. To do this, one or more incoming data streams
are combined, calculations are performed and written to one or more outgoing data streams.
For example, the entity type "AND gate" implements a behavior by subscribing to the two input properties, combining
them into a combination data stream and performing an AND operation on the incoming pairs of values. The result of
the AND operation is itself a data stream and this is linked to the output property.
This example shows how an entity type is wired internally. They are all data streams that are cleverly combined
with one another and thus depict behavior.
It is interesting that this behavior also works for relations. For example, connectors are also implemented
behaviors of streams. It is interesting that connectors connect the data stream from a property instance of the
outgoing entity instance with the data stream from a property instance of the incoming entity instance.
For example the AND-Gate accepts inputs at the properties lhs and rhs. Both streams are subscribed and zipped.
The zipped stream is calculated with a function - in this case the AND-Operator. This results in another
(invisible) stream which is connected with the property result. The entity type AND-Gate defines that the
properties lhs, rhs and result have to exist. Furthermore, the socket types are defined: lhs and rhs are
Input-Sockets and result is a Output-Socket. The behaviour is like the internal wiring of entity instances and
of relation instances. A behaviour can be added to entity instances and removed from entity/relation instances.
Flow
Control flows can be implemented based on the graph, the data streams and the behavior-driven design. It is
important here that the available modules that implement the behavior are linked with connectors.
For example, a flow can consist of a logic that links several AND gates with each other using connectors. Both
the AND gate and the connector are behaviors. But the arrangement of these behaviors within a flow makes them
powerful.
Entire game modes can be implemented with the help of flows. Or just parts of it that are used in multiple game
modes, such as a mechanism to pick up, drop, and score flags.
Flows are also useful for making maps more interactive. With the help of flows and behaviors, it can be ensured
that a door opens in a map when you press switch 1 and switch 2. Or you determine the color of your own team's
base based on the current score. Or you control particle emitters, depending on how many players are near the
emitter. The possibilities for this are endless and want to be used!
Inexor
* Inexor will be a new first-person shooter game which is based on a new octree-based game engine.
* Inexor focuses on classic gameplay as we've seen in Cube2 or the Quake series.
* Inexor will be written from ground up new in C++20 and Rust.
* You can contribute anything you want: code, content, ideas..
* Inexor and all its content is 100% open source!
Development
[Build Instructions](https://inexorgame.github.io/inexor-rgf-application/book/Development_Build.html)
[Data Model](https://inexorgame.github.io/inexor-rgf-application/book/Model.html)
[GraphQL API](https://inexorgame.github.io/inexor-rgf-application/book/GraphQL_API.html)
[Dynamic Graph API](https://inexorgame.github.io/inexor-rgf-application/book/Dynamic_Graph_API.html)
Configuration
[Configuration](https://inexorgame.github.io/inexor-rgf-application/book/Configuration.html)
Further Plugins
| Name | Description | State |
|--------------------------------------------|----------------------------|------------------------------------|
| [Scheduler](./plugins/scheduler/README.md) | Timers and scheduled jobs | TODO: upgrade to newest plugin API |
#### `inexor-rgf-plugins-network`
| Name | Description |
|----------------------------------------|----------------------------|
| [AMQP](./plugins/amqp/README.md) | AMQP client integration |
| [GraphQL](./plugins/graphql/README.md) | GraphQL client integration |
| [MQTT](./plugins/mqtt/README.md) | MQTT client integration |
### `inexor-rgf-plugins-game`
| Name | Description |
|------------------------------------|---------------------------------|
| [Audio](./plugins/audio/README.md) | Integrates with an audio system |
| [Asset](./plugins/asset/README.md) | Download and update assets |
#### `inexor-rgf-plugins-smart`
| Name | Description |
|------------------------------------------------------|--------------------------------------------|
| [Input Device](./plugins/input-device/README.md) | Input device handling |
| [System Command](./plugins/system-command/README.md) | Executes OS commands |
#### `inexor-rgf-plugins-desktop`
| Name | Description |
|--------------------------------------------------|------------------------------|
| [DBUS](./plugins/dbus/README.md) | Integrates with linux dbus |
| [Free Desktop](./plugins/free-desktop/README.md) | Integrates with free desktop |
| [Notification](./plugins/notification/README.md) | Create desktop notifications |
| [Tray](./plugins/tray/README.md) | Integrates with the tray |
Sponsors
_Special thanks to JetBrains for providing us with CLion licenses!_