Skip to content

Commit 926461a

Browse files
authored
Merge pull request #185 from alsed/linux-editor
(Linux) Add a solution when creating new project
2 parents 8f1d2e6 + b4209da commit 926461a

File tree

1 file changed

+51
-9
lines changed

1 file changed

+51
-9
lines changed

manual/get-started/linux.md

Lines changed: 51 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44

55
## Download
66

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).
88

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).
1010

1111
## Requirements
1212

1313
For developers using Flax Editor on Linux platforms the requirements are:
1414

1515
| | Recommended |
1616
|-------|-------|
17-
| Tested operating systems | Ubuntu 23 |
17+
| Tested operating systems | Ubuntu 23 or above |
1818
| Processor | Quad-core or more, 2 GHz or faster |
1919
| RAM | 4 GB or more |
2020
| Hard drive space | 1 GB minimum |
@@ -25,16 +25,25 @@ Flax Editor needs:
2525
* `curl` lib on the system:
2626

2727
```
28-
apt-get install -y curl libcurl4-gnutls-dev
28+
sudo apt-get install -y curl libcurl4-gnutls-dev
2929
```
3030

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:
31+
* `.Net 8 SDK` ([https://dotnet.microsoft.com/en-us/download/dotnet/8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)).
32+
```
33+
sudo apt install dotnet-sdk-8.0
34+
```
35+
36+
.Net version can be verified with:
3237

3338
```
3439
dotnet --version
3540
```
3641

37-
*On Fedora you might need additional fix for invalid lib linkage: `sudo ln -s /usr/lib64/libcurl.so.4 /usr/lib64/libcurl-gnutls.so.4`.
42+
**Note:** On Fedora you might need additional fix for invalid lib linkage:
43+
44+
```
45+
sudo ln -s /usr/lib64/libcurl.so.4 /usr/lib64/libcurl-gnutls.so.4
46+
```
3847

3948
## GPU Drivers
4049

@@ -46,22 +55,41 @@ For information about supported platforms, see [Platforms](../platforms/index.md
4655

4756
## Command line access
4857

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:
5059

5160
| Option | Description |
5261
|-------|-------|
5362
| `-nvidia` | Selects Nvidia GPU. |
5463
| `-amd` | Selects AMD GPU. |
5564
| `-intel` | Selects Intel GPU. |
5665

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).
5867

5968
Example command line to run Editor with custom options:
6069

6170
```
6271
./FlaxEditor -project "<project-path>" -std -nvidia
6372
```
6473

74+
## Run the Editor
75+
76+
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+
6593
## Sample projects
6694

6795
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
7098

7199
## New project
72100

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:
112+
113+
```
114+
chmod a+x Flax.Build
115+
```

0 commit comments

Comments
 (0)