Skip to content

Commit 016c7ad

Browse files
add more descriptions and steps to the setup process (#241)
Co-authored-by: Johannes <kaffeewolf@users.noreply.github.com>
1 parent 6699dd7 commit 016c7ad

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,21 @@ Check out the documentation (WIP) here: https://gscept.github.io/nebula-doc/
2020
3. Added to PATH
2121
4. Installed with debugging symbols and binaries
2222

23+
#### Other useful references and tools
24+
* [Vulkan SDK](https://vulkan.lunarg.com/) and [Vulkan Documentation](https://docs.vulkan.org/) for render pipeline debugging
25+
* [What is Fips](https://floooh.github.io/fips/)
26+
2327
## Quick Start
2428

2529
The fastest way to setup and test nebula is to clone the [Nebula-demo](https://github.com/gscept/nebula-demo) instead. It contains a setup.bat which will setup dependencies and configure a
26-
solution for you to run. If you add a `-editor` commandline argument it will start with the editor ui enabled.
30+
solution for you to run via `fips open`.
31+
Alternatively you can build and run the project manually with `fips build`, `fips run assetbatcher` and `fips run nebula-demo --`. If you add a `-editor` commandline argument it will start with the editor ui enabled.
2732
Apart from that there are a few simple projects in the test folder.
2833
Fips will take care of getting the relevant dependencies (including the actual engine in case you are setting up a external project)
2934

3035
## Normal setup
3136
If you want to proceed with the normal setup you can follow the instructions below.
37+
Proceed to the project iteration section afterwards.
3238

3339
#### Setup config
3440

@@ -40,36 +46,38 @@ If you want to proceed with the normal setup you can follow the instructions bel
4046
Run `fips nebula` verb to set work and toolkit directory registry variables:
4147

4248
* `fips nebula set work {PATH}` (If you are building an external project, this would be the current path)
43-
* `fips nebula set toolkit {PATH}` (this is the path to where the nebula checkout resides, if an external project that would be ../nebula)
49+
* `fips nebula set toolkit {PATH}` (this is the path to where the nebula checkout resides, if an external project that would be `../nebula`)
4450

45-
#### Build project
51+
#### Build project dependencies
4652

4753
In your project directory:
4854

4955
1. `fips physx build vc17 debug` (if you are running VS 2022, use `vc16` or `vc15` for vs 2019/2017 instead)
5056
2. `fips anyfx setup`
51-
3. `fips gen` to generate the required build system files, e.g. a visual studio solution
52-
4. `fips build` to directly compile the project
53-
or
54-
`fips open` to open the generated solution in your selected environment
5557

5658
## Iterating on the project
57-
Once the project is setup and working there are some common operations that you may have to perform.
59+
Once the project is set up and working there are some common operations that you may have to perform.
60+
Most of the steps and operations are required to be completed at least once to be able to run the project.
5861

59-
### Adding files
62+
### Adding files`fips gen`
6063
If you are adding new files, either source or templates or other flatbuffer things that you add to cmake or a cmake subfolder will typically picked up by running `fips gen`. This will regenerate your solution via cmake, in case you are using visual studio it will normally
6164
notice and prompt reloading. Generally calling `fips gen` is a safe operation you can do if dependencies change etc.
6265

63-
### Updating dependencies
66+
#### Location of build files
67+
Fips will place the solution and makefiles and the like in the `../fips-build/{PROJECT-NAME}/{CONFIG}/` folder. Easiest is to just use `fips open` to start your editor
68+
69+
### Updating dependencies – `fips update`
6470
The project you are working in is commonly synced with e.g. git or some other version control, if you have other fips dependencies that changed, you can do a `fips update` to perform a git pull on the depencies used.
6571

66-
### Dealing with content
72+
### Compiling the project – `fips build`
73+
(Re-)Building the project is possible either via the generated solution (`fips open` to open it quickly) or manually with `fips build`.
74+
75+
### Dealing with content – `fips run assetbatcher --`
6776
Content is usually batched using the `assetbatcher` contained in the nebula repository which is built by default by projects as well. Running it will incrementally convert or cook content in your `work` folder to an export folder in the project location. It has a number of options to force or only batch specific folders, as well as
6877
the option to be run in parallel. Running it with `-help` will print some of the options available.
6978

70-
### Location of build files
71-
Fips will place the solution and makefiles and the like in the ../fips-build/projectname/projectconfig/ folder. Easiest is to just use `fips open` to start your editor
72-
79+
## Running the project
80+
To run the debug project without editor tools, use `fips run {PROJECT-NAME}` or run a debug session in your solution opened with `fips open`. Use `fips run {PROJECT-NAME} -- -editor` to run the project with editor ui enabled.
7381

7482
## Features
7583
Nebula is being developed continuously, which means that features keep getting added all the time. Currently, we support this:

0 commit comments

Comments
 (0)