16 releases (10 breaking)

0.11.0 May 23, 2024
0.10.0 Jan 25, 2024
0.9.1 Oct 26, 2023
0.8.0 Jul 22, 2023
0.3.0 May 27, 2022

#194 in Game dev

Download history 59/week @ 2024-02-12 54/week @ 2024-02-19 86/week @ 2024-02-26 48/week @ 2024-03-04 49/week @ 2024-03-11 30/week @ 2024-03-18 19/week @ 2024-03-25 59/week @ 2024-04-01 43/week @ 2024-04-08 26/week @ 2024-04-15 62/week @ 2024-04-22 329/week @ 2024-04-29 17/week @ 2024-05-06 25/week @ 2024-05-13 233/week @ 2024-05-20 73/week @ 2024-05-27

352 downloads per month

MIT license

34KB
833 lines

Fyrox Engine Template Generator

This tiny utility handles project and script generation for Fyrox Game Engine.

Installation

Install it via cargo install:

cargo install fyrox-template

Generating New Project

fyrox-template init [--name <name> --style <style>]

  • name - a name of new project (default is my_game)
  • style - defines a default scene type, either 2d or 3d (default is 3d)

It creates a workspace with three projects:

  • Game - your game project (library)
  • Editor - the editor with your game attached as a plugin
  • Executor - the "runner" for your game.

It also populates each project with boilerplate code. The main purpose of the project is to reduce amount of time that is needed to set up a new project.

It will create a new folder with <project_name> and it will contain three projects, runnable only two of them:

  • cargo run --package editor --release - to run your game inside the editor.
  • cargo run --package executor --release - to run your game as a standalone project. It will also produce final binary of your game, that can be shipped to a store.

Tips

There is nothing special in generated project, so you can tweak them as you wish.

Adding New Scripts

fyrox-template script [--name <name>]

  • name - a name of your script (default is MyScript)

The tool is also capable to generate script skeleton for you, filling it with all required boilerplate. Generated scripts will be added to game/src folder, so you should run the tool from the root folder of your game (where the root Cargo.toml is located).

Do not forget to add the script to your module tree at required position, you probably will need some small tweaks to generated content, it can be easily automated by modern IDEs.

Dependencies

~5.5–7.5MB
~132K SLoC