Skip to content

Commit

Permalink
simplified book structure a bit
Browse files Browse the repository at this point in the history
- removed unnecessary nesting
  • Loading branch information
mrDIMAS committed Jan 1, 2024
1 parent 6fa8355 commit 9f20d46
Show file tree
Hide file tree
Showing 327 changed files with 143 additions and 140 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ jobs:
mdbook-version: "latest"

- name: Test Code
run: mdbook test -L ./Fyrox/target/debug/deps
run: mdbook test -L ./target/debug/deps
258 changes: 129 additions & 129 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,132 +1,132 @@
# Summary

- [About the Book](./introduction.md)
- [Introduction](./fyrox/introduction/index.md)
- [Introduction to Fyrox](./fyrox/introduction/introduction.md)
- [System Requirements and Supported Platforms](./fyrox/introduction/requirements.md)
- [Basic concepts](./fyrox/introduction/basic_concepts.md)
- [Design Philosophy and Goals](./fyrox/introduction/philosophy_and_goals.md)
- [Frequently Asked Questions](./fyrox/introduction/faq.md)
- [Getting started](./fyrox/beginning/getting_started.md)
- [Editor, Plugins and Scripts](./fyrox/beginning/scripting.md)
- [Editor Overview](./fyrox/beginning/editor_overview.md)
- [Scene and scene graph](./fyrox/beginning/scene_and_scene_graph.md)
- [Assets](./fyrox/beginning/assets.md)
- [Data management](./fyrox/beginning/data_management.md)
- [Scripting](./fyrox/scripting/scripting.md)
- [Plugins](./fyrox/scripting/plugin.md)
- [Executor](./fyrox/scripting/executor.md)
- [Scripts](./fyrox/scripting/script.md)
- [Tasks](./fyrox/scripting/tasks.md)
- [Scene](./fyrox/scene/scene.md)
- [Graph](./fyrox/scene/graph.md)
- [Transformation](./fyrox/scene/transform.md)
- [Prefabs](./fyrox/scene/prefab.md)
- [Property Inheritance](./fyrox/scene/inheritance.md)
- [Base Node](./fyrox/scene/base_node.md)
- [Mesh Node](./fyrox/scene/mesh_node.md)
- [Light Node](./fyrox/scene/light_node.md)
- [Sprite Node](./fyrox/scene/sprite_node.md)
- [Particle System Node](./fyrox/scene/particle_system_node.md)
- [Terrain Node](./fyrox/scene/terrain_node.md)
- [Camera Node](./fyrox/scene/camera_node.md)
- [Decal Node](./fyrox/scene/decal_node.md)
- [Rectangle Node](./fyrox/scene/rectangle.md)
- [Custom Node](./fyrox/scene/custom_node.md)
- [Physics](./fyrox/physics/physics.md)
- [Rigid Body](./fyrox/physics/rigid_body.md)
- [Collider](./fyrox/physics/collider.md)
- [Joint](./fyrox/physics/joint.md)
- [Ray Casting](./fyrox/physics/ray.md)
- [Ragdoll](./fyrox/physics/ragdoll.md)
- [Sound](./fyrox/sound/index.md)
- [Audio Bus](./fyrox/sound/bus.md)
- [Sound Node](./fyrox/sound/sound.md)
- [HRTF](./fyrox/sound/hrtf.md)
- [Animation](./fyrox/animation/animation.md)
- [Animation Editor](./fyrox/animation/anim_editor.md)
- [Animation Blending](./fyrox/animation/blending.md)
- [ABSM Editor](./fyrox/animation/absm_editor.md)
- [Signals](./fyrox/animation/signal.md)
- [Root Motion](./fyrox/animation/root_motion/root_motion.md)
- [Input Handling (WIP)](./fyrox/input/input.md)
- [Keyboard (WIP)](./fyrox/input/keyboard.md)
- [Mouse (WIP)](./fyrox/input/mouse.md)
- [Raw Text Input (WIP)](./fyrox/input/text.md)
- [Artificial Intelligence (WIP)](./fyrox/ai/ai.md)
- [Behaviour Trees (WIP)](./fyrox/ai/beh_tree.md)
- [Path Finding](./fyrox/ai/pathfinding.md)
- [Navigational Meshes](./fyrox/ai/navmesh.md)
- [Rendering](./fyrox/rendering/rendering.md)
- [Shaders](./fyrox/rendering/shaders.md)
- [Materials](./fyrox/rendering/materials.md)
- [Light Maps](./fyrox/rendering/lightmaps.md)
- [Settings](./fyrox/rendering/settings.md)
- [Render Pass](./fyrox/rendering/render_pass.md)
- [Normal Maps](./fyrox/rendering/normal_maps.md)
- [Resource Management](./fyrox/resources/resources.md)
- [Models](./fyrox/resources/model.md)
- [Textures](./fyrox/resources/texture.md)
- [Sound Buffers (WIP)](./fyrox/resources/sound.md)
- [Curves (WIP)](./fyrox/resources/curve.md)
- [Custom Resource](./fyrox/resources/custom.md)
- [Hot Reloading (WIP)](./fyrox/resources/hot_reloading.md)
- [User Interface](./fyrox/ui/ui.md)
- [Basic concepts](./fyrox/ui/basic_concepts/basic_concepts.md)
- [Editor](./fyrox/ui/editor/editor.md)
- [Rendering](./fyrox/ui/rendering.md)
- [Fonts](./fyrox/ui/font.md)
- [Style](./fyrox/ui/style.md)
- [Widgets](./fyrox/ui/widgets.md)
- [Custom widget](./fyrox/ui/custom.md)
- [Button](./fyrox/ui/button.md)
- [Border](./fyrox/ui/border.md)
- [Canvas](./fyrox/ui/canvas.md)
- [Check box](./fyrox/ui/checkbox/check_box.md)
- [Curve editor (WIP)](./fyrox/ui/curve_editor.md)
- [Decorator (WIP)](./fyrox/ui/decorator.md)
- [Docking manager (WIP)](./fyrox/ui/dock.md)
- [Dropdown list (WIP)](./fyrox/ui/dropdown_list.md)
- [Expander (WIP)](./fyrox/ui/expander.md)
- [File browser (WIP)](./fyrox/ui/file_browser.md)
- [Grid](./fyrox/ui/grid.md)
- [Image](./fyrox/ui/image.md)
- [Inspector (WIP)](./fyrox/ui/inspector.md)
- [List view (WIP)](./fyrox/ui/list_view.md)
- [Menu (WIP)](./fyrox/ui/menu.md)
- [Message box (WIP)](./fyrox/ui/message_box.md)
- [Numeric field](./fyrox/ui/numeric.md)
- [Popup (WIP)](./fyrox/ui/popup.md)
- [Progress bar (WIP)](./fyrox/ui/progress_bar.md)
- [Range (WIP)](./fyrox/ui/range.md)
- [Rect (WIP)](./fyrox/ui/rect.md)
- [Scroll bar](./fyrox/ui/scroll_bar.md)
- [Scroll panel](./fyrox/ui/scroll_panel.md)
- [Scroll viewer](./fyrox/ui/scroll_viewer.md)
- [Screen](./fyrox/ui/screen.md)
- [Stack panel](./fyrox/ui/stack_panel.md)
- [Tab control](./fyrox/ui/tab_control.md)
- [Text](./fyrox/ui/text.md)
- [Text box](./fyrox/ui/text_box.md)
- [Tree (WIP)](./fyrox/ui/tree.md)
- [Vector image](./fyrox/ui/vector_image.md)
- [Window](./fyrox/ui/window.md)
- [Wrap panel](./fyrox/ui/wrap_panel.md)
- [Serialization](./fyrox/serialization/index.md)
- [Saved Games](./fyrox/serialization/save.md)
- [Editor](./fyrox/editor/index.md)
- [Property Editors](./fyrox/editor/property_editors.md)
- [Settings](./fyrox/editor/settings.md)
- [Miscellaneous](./fyrox/misc/misc.md)
- [Log](./fyrox/misc/log.md)
- [Tutorials](./fyrox/tutorials/tutorials.md)
- [FPS Tutorial](./fyrox/tutorials/fps/intro.md)
- [Character controller](./fyrox/tutorials/fps/tutorial-1/tutorial-part-1.md)
- [Weapons](./fyrox/tutorials/fps/tutorial-2/tutorial-part-2.md)
- [Bots and AI](./fyrox/tutorials/fps/tutorial-3/tutorial-part-3.md)
- [RPG Tutorial](./fyrox/tutorials/rpg/intro.md)
- [Character controller](./fyrox/tutorials/rpg/tutorial-1/tutorial-part-1.md)
- [2D Platformer tutorial](./fyrox/tutorials/platformer/part1.md)
- [Performance](./fyrox/performance/index.md)
- [Obsolete](./fyrox/obsolete/obsolete.md)
- [Custom game loop](./fyrox/obsolete/custom_game_loop.md)
- [Introduction](./introduction/index.md)
- [Introduction to Fyrox](./introduction/introduction.md)
- [System Requirements and Supported Platforms](./introduction/requirements.md)
- [Basic concepts](./introduction/basic_concepts.md)
- [Design Philosophy and Goals](./introduction/philosophy_and_goals.md)
- [Frequently Asked Questions](./introduction/faq.md)
- [Getting started](./beginning/getting_started.md)
- [Editor, Plugins and Scripts](./beginning/scripting.md)
- [Editor Overview](./beginning/editor_overview.md)
- [Scene and scene graph](./beginning/scene_and_scene_graph.md)
- [Assets](./beginning/assets.md)
- [Data management](./beginning/data_management.md)
- [Scripting](./scripting/scripting.md)
- [Plugins](./scripting/plugin.md)
- [Executor](./scripting/executor.md)
- [Scripts](./scripting/script.md)
- [Tasks](./scripting/tasks.md)
- [Scene](./scene/scene.md)
- [Graph](./scene/graph.md)
- [Transformation](./scene/transform.md)
- [Prefabs](./scene/prefab.md)
- [Property Inheritance](./scene/inheritance.md)
- [Base Node](./scene/base_node.md)
- [Mesh Node](./scene/mesh_node.md)
- [Light Node](./scene/light_node.md)
- [Sprite Node](./scene/sprite_node.md)
- [Particle System Node](./scene/particle_system_node.md)
- [Terrain Node](./scene/terrain_node.md)
- [Camera Node](./scene/camera_node.md)
- [Decal Node](./scene/decal_node.md)
- [Rectangle Node](./scene/rectangle.md)
- [Custom Node](./scene/custom_node.md)
- [Physics](./physics/physics.md)
- [Rigid Body](./physics/rigid_body.md)
- [Collider](./physics/collider.md)
- [Joint](./physics/joint.md)
- [Ray Casting](./physics/ray.md)
- [Ragdoll](./physics/ragdoll.md)
- [Sound](./sound/index.md)
- [Audio Bus](./sound/bus.md)
- [Sound Node](./sound/sound.md)
- [HRTF](./sound/hrtf.md)
- [Animation](./animation/animation.md)
- [Animation Editor](./animation/anim_editor.md)
- [Animation Blending](./animation/blending.md)
- [ABSM Editor](./animation/absm_editor.md)
- [Signals](./animation/signal.md)
- [Root Motion](./animation/root_motion/root_motion.md)
- [Input Handling (WIP)](./input/input.md)
- [Keyboard (WIP)](./input/keyboard.md)
- [Mouse (WIP)](./input/mouse.md)
- [Raw Text Input (WIP)](./input/text.md)
- [Artificial Intelligence (WIP)](./ai/ai.md)
- [Behaviour Trees (WIP)](./ai/beh_tree.md)
- [Path Finding](./ai/pathfinding.md)
- [Navigational Meshes](./ai/navmesh.md)
- [Rendering](./rendering/rendering.md)
- [Shaders](./rendering/shaders.md)
- [Materials](./rendering/materials.md)
- [Light Maps](./rendering/lightmaps.md)
- [Settings](./rendering/settings.md)
- [Render Pass](./rendering/render_pass.md)
- [Normal Maps](./rendering/normal_maps.md)
- [Resource Management](./resources/resources.md)
- [Models](./resources/model.md)
- [Textures](./resources/texture.md)
- [Sound Buffers (WIP)](./resources/sound.md)
- [Curves (WIP)](./resources/curve.md)
- [Custom Resource](./resources/custom.md)
- [Hot Reloading (WIP)](./resources/hot_reloading.md)
- [User Interface](./ui/ui.md)
- [Basic concepts](./ui/basic_concepts/basic_concepts.md)
- [Editor](./ui/editor/editor.md)
- [Rendering](./ui/rendering.md)
- [Fonts](./ui/font.md)
- [Style](./ui/style.md)
- [Widgets](./ui/widgets.md)
- [Custom widget](./ui/custom.md)
- [Button](./ui/button.md)
- [Border](./ui/border.md)
- [Canvas](./ui/canvas.md)
- [Check box](./ui/checkbox/check_box.md)
- [Curve editor (WIP)](./ui/curve_editor.md)
- [Decorator (WIP)](./ui/decorator.md)
- [Docking manager (WIP)](./ui/dock.md)
- [Dropdown list (WIP)](./ui/dropdown_list.md)
- [Expander (WIP)](./ui/expander.md)
- [File browser (WIP)](./ui/file_browser.md)
- [Grid](./ui/grid.md)
- [Image](./ui/image.md)
- [Inspector (WIP)](./ui/inspector.md)
- [List view (WIP)](./ui/list_view.md)
- [Menu (WIP)](./ui/menu.md)
- [Message box (WIP)](./ui/message_box.md)
- [Numeric field](./ui/numeric.md)
- [Popup (WIP)](./ui/popup.md)
- [Progress bar (WIP)](./ui/progress_bar.md)
- [Range (WIP)](./ui/range.md)
- [Rect (WIP)](./ui/rect.md)
- [Scroll bar](./ui/scroll_bar.md)
- [Scroll panel](./ui/scroll_panel.md)
- [Scroll viewer](./ui/scroll_viewer.md)
- [Screen](./ui/screen.md)
- [Stack panel](./ui/stack_panel.md)
- [Tab control](./ui/tab_control.md)
- [Text](./ui/text.md)
- [Text box](./ui/text_box.md)
- [Tree (WIP)](./ui/tree.md)
- [Vector image](./ui/vector_image.md)
- [Window](./ui/window.md)
- [Wrap panel](./ui/wrap_panel.md)
- [Serialization](./serialization/index.md)
- [Saved Games](./serialization/save.md)
- [Editor](./editor/index.md)
- [Property Editors](./editor/property_editors.md)
- [Settings](./editor/settings.md)
- [Miscellaneous](./misc/misc.md)
- [Log](./misc/log.md)
- [Tutorials](./tutorials/tutorials.md)
- [FPS Tutorial](./tutorials/fps/intro.md)
- [Character controller](./tutorials/fps/tutorial-1/tutorial-part-1.md)
- [Weapons](./tutorials/fps/tutorial-2/tutorial-part-2.md)
- [Bots and AI](./tutorials/fps/tutorial-3/tutorial-part-3.md)
- [RPG Tutorial](./tutorials/rpg/intro.md)
- [Character controller](./tutorials/rpg/tutorial-1/tutorial-part-1.md)
- [2D Platformer tutorial](./tutorials/platformer/part1.md)
- [Performance](./performance/index.md)
- [Obsolete](./obsolete/obsolete.md)
- [Custom game loop](./obsolete/custom_game_loop.md)
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,10 @@ A scene can contain various game entities. There are two equivalent ways of crea
- By going to `Create` in the main menu and selecting the desired entity from the drop down.
- By right-clicking on a game entity in the `World Viewer` and selecting the desired entity from the `Add Child` sub-menu.

Complex objects usually made in 3D modelling software (Blender, 3Ds Max, Maya, etc.) can be saved in various formats. Fyrox supports
FBX format, which is supported by pretty much any 3D modelling software. You can instantiate such objects by simply dragging the one you want and dropping it on the `Scene Preview`. While dragging it, you'll also see a preview of the object.
Complex objects usually made in 3D modelling software (Blender, 3Ds Max, Maya, etc.) can be saved in various formats.
Fyrox supports FBX format, which is supported by pretty much any 3D modelling software. You can instantiate such objects
by simply dragging the one you want and dropping it on the `Scene Preview`. While dragging it, you'll also see a preview
of the object.

You can do the same with other scenes made in the editor (`rgs` files), for example, you can create a scene with a few objects in it
with some scripts and re-use them within other scenes. Such scenes are called [prefabs](../scene/prefab.md).
Expand Down Expand Up @@ -99,7 +101,5 @@ giving a chance to break the editor by running the game.
There are also number of powerful utilities that will make your life easier, they can be found under the `Utils` section of the
main menu:

- Animation Editor - allows you to create and edit animation blending state machines which are responsible for
animation mixing.
- Curve Editor - allows you to create and edit curve resources to make complex laws for game parameters.
- Path Fixer - helps you fix incorrect resource references in your scenes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
1 change: 0 additions & 1 deletion src/fyrox/input/input.md

This file was deleted.

4 changes: 4 additions & 0 deletions src/input/input.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Input

This chapter explains how the input handling in the engine works. The input system based on various events, that comes
to the window.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Practical reference and user guides for [Fyrox Game Engine](https://github.com/F

Fyrox Team is trying to keep the book up-to-date with the latest version from `master` branch. If something does not
compile with the latest release from crates.io, then you need to
[use the latest engine from GitHub repo](./fyrox/beginning/scripting.md#using-latest-engine-version).
[use the latest engine from GitHub repo](./beginning/scripting.md#using-latest-engine-version).

## How to read the book

Expand Down
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion src/fyrox/scene/scene.md → src/scene/scene.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ manually by instantiating respective prefabs at runtime.

### Using FyroxEd

There is a [separate chapter](../../fyrox/beginning/editor_overview.md) in the book that should help you to create a
There is a [separate chapter](../../beginning/editor_overview.md) in the book that should help you to create a
scene. After a scene is created, you can load it as any other 3D model (or prefab) using the resource manager:

```rust,no_run
Expand Down
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
Loading

0 comments on commit 9f20d46

Please sign in to comment.