Skip to content

Latest commit

 

History

History
78 lines (60 loc) · 3.56 KB

2-run-steel-editor.md

File metadata and controls

78 lines (60 loc) · 3.56 KB
Raw

Run Steel Editor

Set up the environment

Currently, it is recommended to run in VSCode, convenient for debugging.

  1. Install Visual Studio 2022 with "Desktop development with C++" in Windows, keep the default check.
  2. Install Rust, Git, Python, CMake and Ninja for shaderc-rs.
  3. Install VSCode with "C/C++" and "rust-analyzer" extensions.

Run Steel Editor

The Steel Editor can be run by compiling the source code, or by running it directly using the compiled executable file. Currently, it is recommended to open the Steel source code in VSCode to run the Steel Editor, because it is convenient for debugging. The subsequent content and pictures in this tutorial are based on running the Steel Editor using the source code, but it is also applicable to running the Steel Editor using the executable file.

Run from source

  1. Download the code of the Steel, and checkout "v0.2" branch, because the current tutorial is written based on this version:
git clone https://github.com/SSSxCCC/steel
cd steel
git checkout v0.2
  1. Use VSCode to open the root directory "steel" and press F5 to compile and run in debug mode. Or you can run it using the command:
cargo run -p steel-editor -F desktop

Run using executable file

  1. Download "steel-editor.zip" from the Releases page and unzip it.
  2. Open Windows PowerShell and execute:
cd steel-editor
.\steel-editor.exe

Steel editor UI introduction

After successfully running the Steel editor, you can see the following interface:

image

In front of the entire interface is the editor window. In the editor window there are top menu function buttons and multiple tabs. Tabs mainly include:

  • Scene: Scene window, this window is used to view scene content;
  • Game: Game window, this window is used to view the actual game screen;
  • Entities: Displays all entities in the current scene;
  • Entity: Displays all components of the currently selected entity;
  • Uniques: Display all uniques in the current scene;
  • Unique: Displays the contents of the currently selected unique.

Behind the editor window is the VSCode window. All logs output in the editor are displayed in the terminal below VSCode. Currently, all Steel engine codes have been opened in VSCode and can be viewed and modified at any time. At the same time, VSCode is also used to view and modify the project code created by the Steel editor. The specific method will be introduced in subsequent chapters.

There is an examples directory under the Steel engine source code directory, and there is a ball directory under it, which is the final content of the catch ball game of the example project of this tutorial. If you encounter difficulties while reading this tutorial, you can open the ball directory under the examples directory at any time for reference.

Next: Create Project

Prev: Introduction

Table of Contents