Fyrox Game Engine

The fyrox-autotile crate provides two primary algorithms for automating tile placement on regular grids (including square, hexagonal, or 3D grids):

1. Interactive Terrain-based Autotiling: Designed for tile map editing. Users select a broad 'terrain' category for a cell, and the algorithm automatically selects the specific tile that fits naturally with its neighbors. This is based on the terrain-autotiler library.
2. Wave Function Collapse (WFC): Designed for randomized tile generation. It uses randomization to generate creative tile layouts, potentially replacing manual artist work. This is based on the fast-wfc library.

fyrox-sound is a Rust-based sound library designed for games and interactive applications. While it carries the fyrox prefix, it is a standalone crate that can be used independently of the Fyrox engine.

Key Features

• Sound Sources: Supports both Generic and Spatial sound sources.
• Streaming: Built-in streaming capabilities for playing large audio files.
• Format Support:
  • WAV (non-compressed)
  • Vorbis/Ogg (via lewton)
• Raw Playback: Support for playing raw samples.
• Audio Effects:
  • HRTF: Head-related transfer function support for binaural effects and precise positioning.
  • Reverb: Built-in reverb effect.

The fyrox-animation crate provides a flexible, general-purpose, and reflection-based animation system designed for game development.

Note: Although the crate uses the fyrox prefix, it is a standalone library and can be used in projects without the full fyrox engine.

fyrox-ui is a retained-mode, general-purpose, and graphics API-agnostic user interface library inspired by WPF. It is designed to be used independently of the fyrox engine.

Key features include:

• Over 28 built-in widgets (e.g., Button, Grid, Tree, Window, Inspector).
• Full TTF/OTF font support.
• A powerful, flexible layout system.
• OS-agnosticism: widgets look consistent across different operating systems.
• GAPI-agnosticism: it does not depend on a specific rendering backend (OpenGL, DirectX, Vulkan, Metal, etc.).
• Extensibility: full support for user-defined widgets.

The fyrox-core-derive crate provides procedural macros to automatically implement essential Fyrox traits for your custom types. These macros allow your types to participate in the engine's serialization, inspection, and reflection systems.

Supported derive macros:

• #[derive(Visit)]: Implements the Visit trait, used for serializing and deserializing data structures.
• #[derive(Inspect)]: Implements the Inspect trait, allowing your types to be displayed and edited within the Fyrox editor/inspector.
• #[derive(Reflect)]: Implements the Reflect trait, enabling runtime reflection capabilities for your types.

FyroxEd is a full-featured editor library for the Fyrox engine. Note that this specific package is a library and cannot be run as a standalone executable.

Its primary purpose is to serve as a base for building editors with static plugins. If you need to run the editor as a standalone application, use the editor-standalone component instead.

Fyrox is a feature-rich, production-ready, general-purpose 2D/3D game engine written in Rust. It includes a scene editor and is formerly known as rg3d.

To begin learning how to use the engine, refer to the official Fyrox Book, which covers everything from initial setup and building to various practical tutorials: https://fyrox-book.github.io/

Because fyrox-ui is OS- and GAPI-agnostic, it cannot create native OS windows or render directly to the screen. Instead, it manages an internal draw buffer containing a list of commands.

To display the UI, you must implement a UI renderer in your application that interprets these commands and executes the corresponding drawing operations using your chosen graphics API (e.g., Vulkan, OpenGL).

If you have questions or need support, you can engage with the community through the following channels:

• Discord: Join the official Discord server.
• GitHub Discussions: Participate in technical discussions directly on GitHub.

Use the following keyboard and mouse controls to navigate and interact with the FyroxEd editor:

Navigation & Selection

• Click: Select objects
• W, S, A, D: Move camera
• Space: Raise camera
• Q / E: Lower camera

Interaction Modes

• 1: Select interaction mode
• 2: Move interaction mode
• 3: Scale interaction mode
• 4: Rotate interaction mode

Editing

• Ctrl + Z: Undo
• Ctrl + Y: Redo