Skip to content

Commit

Permalink
initial documentation updates for recent exporter changes for point r…
Browse files Browse the repository at this point in the history
…elease (#2519)

* initial documentation updates for recent exporter changes for point release

Signed-off-by: TJ Kotha <tankotha@amazon.com>

* Update content/docs/user-guide/packaging/project-export/project-export-cli.md

Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com>
Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com>

* Update content/docs/user-guide/packaging/project-export/project-export-cli.md

Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com>
Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com>

* Update content/docs/user-guide/packaging/project-export/project-export-cli.md

Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com>
Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com>

* Update content/docs/user-guide/packaging/project-export/project-export-cli.md

Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com>
Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com>

* Update content/docs/user-guide/packaging/project-export/project-export-cli.md

Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com>
Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com>

* Update content/docs/user-guide/packaging/project-export/project-export-cli.md

Co-authored-by: Gene Walters <32776221+AMZN-Gene@users.noreply.github.com>
Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com>

* addressed feedback

Signed-off-by: TJ Kotha <tankotha@amazon.com>

* removed unnecessary warning for profile builds

Signed-off-by: TJ Kotha <tankotha@amazon.com>

* Update content/docs/user-guide/packaging/project-export/project-export-cli.md

Co-authored-by: Gene Walters <32776221+AMZN-Gene@users.noreply.github.com>
Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com>

* Update content/docs/user-guide/packaging/project-export/project-export-cli.md

Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com>
Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com>

* Update content/docs/user-guide/packaging/project-export/project-export-cli.md

Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com>
Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com>

* Update content/docs/user-guide/packaging/project-export/project-export-cli.md

Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com>
Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com>

* Update content/docs/user-guide/packaging/project-export/project-export-cli.md

Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com>
Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com>

* Update content/docs/user-guide/packaging/project-export/project-export-cli.md

Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com>
Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com>

* Update content/docs/user-guide/packaging/project-export/project-export-cli.md

Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com>
Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com>

* Update content/docs/user-guide/packaging/project-export/project-export-cli.md

Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com>
Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com>

* adding wildcard documentation for seed parameters

Signed-off-by: TJ Kotha <tankotha@amazon.com>

* splitting argument table into separate unique entries

Signed-off-by: TJ Kotha <tankotha@amazon.com>

* minor sentence improvement

Signed-off-by: TJ Kotha <tankotha@amazon.com>

* minor sentence improvements

Signed-off-by: TJ Kotha <tankotha@amazon.com>

* split up snippets into smaller sections

Signed-off-by: TJ Kotha <tankotha@amazon.com>

---------

Signed-off-by: TJ Kotha <tankotha@amazon.com>
Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com>
Co-authored-by: TJ Kotha <tankotha@amazon.com>
Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com>
Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com>
Co-authored-by: Gene Walters <32776221+AMZN-Gene@users.noreply.github.com>
  • Loading branch information
5 people authored and jhanca-robotecai committed Aug 16, 2024
1 parent 2c0e5fe commit 7bfd494
Showing 1 changed file with 0 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -102,21 +102,6 @@ or in condensed form:
<engine-folder>\scripts\o3de.bat export-project -es C:\..\path\to\export-script -pp C:\..\path\to\project-folder -ll INFO
```

### Project Template

Project Export functionality is also available on a per-project basis. This is because there are helper export scripts that are included in the Project Templates, as can be seen with [`package.bat`](https://github.com/o3de/o3de/blob/f25503785829c3eb75d3f00420d2072985d5ed05/Templates/DefaultProject/Template/package.bat) and [`package.sh` for Unix](https://github.com/o3de/o3de/blob/f25503785829c3eb75d3f00420d2072985d5ed05/Templates/DefaultProject/Template/package.sh). These scripts are included at the root folder of every new Project created with the `DefaultProject` template.

The package scripts pre-populate the relevant arguments for the given project, and then call `export-project` on the user's behalf.

In order to use it, simply run the following command (assuming project has already been created and registered):
```
# On Windows
\path\to\project\package.bat
#On Unix
\path\to\project\package.sh
```

## Standard Export Script
O3DE now ships with a [standard project export script](https://github.com/o3de/o3de/blob/753480ec930e55f3431f92ed7b974ba7f9e73a13/scripts/o3de/ExportScripts/export_source_built_project.py), capable of automating most typical use cases of projects. The code and API are provided so that users with more particular needs can investigate, expand or modify the code as necessary. Currently this script only supports Windows and Linux platforms, and does not handle deployment to external services.

Expand Down Expand Up @@ -189,11 +174,6 @@ An example usage of the entire `export-project` command, including this script,
```
Where `O3DE_ENGINE_PATH`, `O3DE_PROJECT_PATH` and `OUTPUT_PATH` are environment variables. This single invocation should be all that is needed to fully export MultiplayerSample into a release directory ready for distribution.

{{< important >}}
--no-monolithic-build and --config profile is required when building from an O3DE installer or SDK.
See [Installed Engine Fails to Export Monolithic Release.](https://github.com/o3de/o3de/issues/17203)
{{< /important >}}

For more information on how to export the MultiplayerSample project using the CLI, please see [these instructions](https://github.com/o3de/o3de-multiplayersample/blob/f00b3035285b695b2dbd1b1e59912973f4e1a32f/Documentation/O3DEMPSProjectExportTesting.md).

## Export Script Configurations
Expand Down

0 comments on commit 7bfd494

Please sign in to comment.