Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,30 @@
# Destiny
> Core game world simulation engine for popular spaceship based MMO Eve Online.

# How to build
The project is build using CMake.

## Building
## Configuring
Configuration is best managed using the presets included in the project. To see the list of available presets, run
the following from the project root:

`cmake --list-presets`

To configure your project with a given preset, run the following from the project root:

`cmake --preset [preset]`

In order to build the library you need access to Perforce, as that is where some of our dependencies live. The build
instructions then expect a `CCP_EVE_PERFORCE_BRANCH_PATH` environment variable that points at the location of the
Perforce branch.
This will build using the default generator as configured by the `CMAKE_GENERATOR` environment variable on the host
machine. The generator can also be explicitly provided during configuration:

`cmake -G [generator] --preset [preset]`

For typical use cases, we recommend the `Ninja Multi-Config` generator.

## Building
After configuration is complete, run the following:

Once that is set up, building can be done using the usual CMake work flow
`cmake --build [BUILD_DIRECTORY]`

## 📄 License and Legal Notices

Expand Down