You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: manual/get-started/linux.md
+51-9Lines changed: 51 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -4,17 +4,17 @@
4
4
5
5
## Download
6
6
7
-
You can get Flax from your [Download](https://flaxengine.com/download/) page or compile it manually from the official [source code repository](https://github.com/FlaxEngine/FlaxEngine).
7
+
You can get Flax from your [Download](https://flaxengine.com/download/) page, or compile it manually from the official [source code repository](https://github.com/FlaxEngine/FlaxEngine).
8
8
9
-
The Editor executable is in folder `Binaries/Editor/Linux/Development/FlaxEditor` (you can use also Debug or Release configuration if you want).
9
+
The Editor executable is located in folder `Binaries/Editor/Linux/Development/FlaxEditor` (you can use also Debug or Release configuration if you want).
10
10
11
11
## Requirements
12
12
13
13
For developers using Flax Editor on Linux platforms the requirements are:
14
14
15
15
|| Recommended |
16
16
|-------|-------|
17
-
| Tested operating systems | Ubuntu 23 |
17
+
| Tested operating systems | Ubuntu 23 or above |
18
18
| Processor | Quad-core or more, 2 GHz or faster |
19
19
| RAM | 4 GB or more |
20
20
| Hard drive space | 1 GB minimum |
@@ -25,16 +25,25 @@ Flax Editor needs:
25
25
*`curl` lib on the system:
26
26
27
27
```
28
-
apt-get install -y curl libcurl4-gnutls-dev
28
+
sudo apt-get install -y curl libcurl4-gnutls-dev
29
29
```
30
30
31
-
*`.Net 8 SDK` ([https://dotnet.microsoft.com/en-us/download/dotnet/8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)). Setup can be verified with:
@@ -46,22 +55,41 @@ For information about supported platforms, see [Platforms](../platforms/index.md
46
55
47
56
## Command line access
48
57
49
-
Ig you're using laptop with integrated GPU and you want Flax to run on dedicated GPU for more power you can use command line switches to instruct engine to select a desire GPU based on the manufacturer:
58
+
If you're using laptop with integrated GPU, and you want Flax to run on dedicated GPU for more power, you can use command line switches to instruct engine to select a desire GPU based on the manufacturer:
50
59
51
60
| Option | Description |
52
61
|-------|-------|
53
62
|`-nvidia`| Selects Nvidia GPU. |
54
63
|`-amd`| Selects AMD GPU. |
55
64
|`-intel`| Selects Intel GPU. |
56
65
57
-
To learn more about command line switches see [this documentation page](../editor/advanced/command-line-access.md).
66
+
To learn more about command line switches see the [command line access page](../editor/advanced/command-line-access.md).
58
67
59
68
Example command line to run Editor with custom options:
The Editor is located in `Binaries/Editor/Linux/Development/FlaxEditor`.
77
+
78
+
To run the editor, Flax needs to know the path of the folder that contains the project files:
79
+
80
+
```
81
+
./FlaxEditor -project <"project-path">
82
+
```
83
+
84
+
In case you don't specify a project path, a windows will appear asking you to indicate where the `flax-proj` file is located.
85
+
86
+
87
+
```
88
+
./FlaxEditor
89
+
```
90
+
91
+
You can start by using a Sample project or creating a new project.
92
+
65
93
## Sample projects
66
94
67
95
To help you start using Flax pick the latest Flax Samples from [https://github.com/FlaxEngine/FlaxSamples](https://github.com/FlaxEngine/FlaxSamples). This collection contains various example projects that showcase the engine features and can be used as a foundation for your future Flax projects. Have fun!
@@ -70,4 +98,18 @@ To help you start using Flax pick the latest Flax Samples from [https://github.c
70
98
71
99
## New project
72
100
73
-
To create a new project to run Flax Editor executable as follows `./FlaxEditor -new -project <new_project_path>` to create a new project inside a specified folder. Editor will generate a project template and open it.
101
+
To create a new project, first you need to create a new folder that will contain the project files. Then, run Flax Editor executable as follows:
102
+
103
+
```
104
+
./FlaxEditor -new -project <"new_project_path">
105
+
```
106
+
This will create a new project inside the specified folder. The Editor will generate a project template and open it.
107
+
108
+
From here, you'll probably want to know how to [create a Scene](https://docs.flaxengine.com/manual/get-started/scenes/index.html) , or take the first steps on the [Flax Editor](https://docs.flaxengine.com/manual/get-started/editor.html).
109
+
110
+
111
+
**Note:** When creating a new project, if the Editor informs that a *script compilation failure* has ocurred, is because `Flax.Build` file needs to be set as an executable. In folder `Binaries/Tools` right-click on the file, select "Properties", and check the box that says "Allow executing file as program". Or use the command line:
0 commit comments