diff --git a/src/fyrox/beginning/scripting.md b/src/fyrox/beginning/scripting.md index 9937da90..be4e9d93 100644 --- a/src/fyrox/beginning/scripting.md +++ b/src/fyrox/beginning/scripting.md @@ -5,6 +5,18 @@ editor and to be able to edit the game entities in it. Your game can define any to scene objects to run custom game logic on them. In this chapter you'll learn the basics: how to install the engine with its platform-specific dependencies, how to use the plugins and scripting system, how to run the editor. +## Quick Start + +Run the following commands to start using the engine as quick as possible. Read the next chapters if you want to know +more or if you have any issues with this. + +```sh +cargo install fyrox-template +fyrox-template init --name fyrox_test --style 2d +cd fyrox_test +cargo run --package editor --release +``` + ## Platform-specific Dependencies Before you start using the engine, make sure you have all required platform-specific development dependencies installed, diff --git a/src/fyrox/introduction/introduction.md b/src/fyrox/introduction/introduction.md index 8b353547..5eb9f6cd 100644 --- a/src/fyrox/introduction/introduction.md +++ b/src/fyrox/introduction/introduction.md @@ -27,4 +27,163 @@ that can be used to create game worlds, manage assets, edit game objects, script Everything of your game can be written entirely in Rust, utilizing its safety guarantees as well as speed. However, it is possible to use any scripting language you want, but that's have no built-in support and you need to implement this -manually. \ No newline at end of file +manually. + +## Engine Features + +This is a more or less complete (yet, it can be outdated) list of engine features: + +### General + +- Exceptional safety, reliability, and speed. +- PC (Windows, Linux, macOS), Android, [Web (WebAssembly) support](https://fyrox.rs/examples). +- Modern, PBR rendering pipeline. +- Comprehensive [documentation](https://docs.rs/Fyrox). +- [Guide book](https://fyrox-book.github.io) +- 2D support. +- Integrated editor. +- Fast iterative compilation. +- Classic object-oriented design. +- Lots of examples. + +### Rendering + +- Custom shaders, materials, and rendering techniques. +- Physically-based rendering. +- Metallic workflow. +- High dynamic range (HDR) rendering. +- Tone mapping. +- Color grading. +- Auto-exposure. +- Gamma correction. +- Deferred shading. +- Directional light. +- Point lights + shadows. +- Spotlights + shadows. +- Screen-Space Ambient Occlusion (SSAO). +- Soft shadows. +- Volumetric light (spot, point). +- Batching. +- Instancing. +- Fast Approximate Anti-Aliasing (FXAA). +- Normal mapping. +- Parallax mapping. +- Render in texture. +- Forward rendering for transparent objects. +- Sky box. +- Deferred decals. +- Multi-camera rendering. +- Lightmapping. +- Soft particles. +- Fully customizable vertex format. +- Compressed textures support. +- High-quality mip-map on-demand generation. + +### Scene + +- Multiple scenes. +- Full-featured scene graph. +- Level-of-detail (LOD) support. +- GPU Skinning. +- Various scene nodes: + - Pivot. + - Camera. + - Decal. + - Mesh. + - Particle system. + - Sprite. + - Multilayer terrain. + - Rectangle (2D Sprites) + - Rigid body + Rigid Body 2D + - Collider + Collider 2D + - Joint + Joint 2D + +### Sound + +- [High quality binaural sound with HRTF support](https://github.com/FyroxEngine/Fyrox/tree/master/fyrox-sound). +- Generic and spatial sound sources. +- Built-in streaming for large sounds. +- Raw samples playback support. +- WAV/OGG format support. +- HRTF support for excellent positioning and binaural effects. +- Reverb effect. + +### Serialization + +- Powerful serialization system +- Almost every entity of the engine can be serialized +- No need to write your own serialization. + +### Animation + +- Animation blending state machine - similar to Mecanim in Unity Engine. +- Animation retargetting - allows you to remap animation from one model to another. + +### Asset management + +- Advanced asset manager. +- Fully asynchronous asset loading. +- PNG, JPG, TGA, DDS, etc. textures. +- FBX models loader. +- WAV, OGG sound formats. +- Compressed textures support (DXT1, DXT3, DTX5). + +### Artificial Intelligence (AI) + +- A* pathfinder. +- Navmesh. +- Behavior trees. + +### User Interface (UI) + +- [Advanced node-based UI](https://github.com/FyroxEngine/Fyrox/tree/master/fyrox-ui) with lots of widgets. +- More than 32 widgets +- Powerful layout system. +- Full TTF/OTF fonts support. +- Based on message passing. +- Fully customizable. +- GAPI-agnostic. +- OS-agnostic. +- Button widget. +- Border widget. +- Canvas widget. +- Color picker widget. +- Color field widget. +- Check box widget. +- Decorator widget. +- Drop-down list widget. +- Grid widget. +- Image widget. +- List view widget. +- Popup widget. +- Progress bar widget. +- Scroll bar widget. +- Scroll panel widget. +- Scroll viewer widget. +- Stack panel widget. +- Tab control widget. +- Text widget. +- Text box widget. +- Tree widget. +- Window widget. +- File browser widget. +- File selector widget. +- Docking manager widget. +- NumericUpDown widget. +- `Vector3` editor widget. +- Menu widget. +- Menu item widget. +- Message box widget. +- Wrap panel widget. +- Curve editor widget. +- User defined widget. + +### Physics + +- Advanced physics (thanks to the [rapier](https://github.com/dimforge/rapier) physics engine) +- Rigid bodies. +- Rich set of various colliders. +- Joints. +- Ray cast. +- Many other useful features. +- 2D support. \ No newline at end of file diff --git a/src/introduction.md b/src/introduction.md index 1a874577..192b72ec 100644 --- a/src/introduction.md +++ b/src/introduction.md @@ -1,7 +1,8 @@ # Fyrox Game Engine Book -Practical reference and user guides for [Fyrox Game Engine](https://github.com/FyroxEngine/Fyrox) and its -editor [FyroxEd](https://github.com/FyroxEngine/Fyrox/tree/master/editor). +Practical reference and user guides for [Fyrox Game Engine](https://github.com/FyroxEngine/Fyrox) and its editor [FyroxEd](https://github.com/FyroxEngine/Fyrox/tree/master/editor). + +> ⚠️ Tip: If you want to start using the engine as fast as possible - read this [chapter](fyrox/beginning/scripting.md). **Warning:** The book is in early development stage, you can help to improve it by making a contribution in its [repository](https://github.com/fyrox-book/fyrox-book.github.io). Don't be shy, every tip is helpful! @@ -16,8 +17,7 @@ compile with the latest release from crates.io, then you need to Almost every chapter in this book can be read in any order, but we recommend reading Chapters 1, 2, 3 (they're quite small) and then going through [Platformer Tutorial (2D)](fyrox/tutorials/platformer/part1.md) while learning more about specific -areas that interest you from the other chapters. If you want to start using the engine as fast as possible, then read this -[chapter](fyrox/beginning/scripting.md). +areas that interest you from the other chapters. There is also a [First-Person Shooter Tutorial (3D)](fyrox/tutorials/fps/intro.md), but it is based on framework which considered obsolete, yet it is still very helpful.