Skip to content
Open
Show file tree
Hide file tree
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
33 changes: 33 additions & 0 deletions Docs/BUILD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Building the project into a package

A unity package is simply a modified compressed file containg Unity assets(i.e images, scripts, configs, etc.).

To build the project and export it as a unity package.
You need to identify the version of unity you need to support.
Due to the changes being made across versions, especially across major versions.
You might need to make changes tailored to those versions.
This is assuming the current version of the source code hasn't already made those changes
for you.

First download the source code.

## Manually from Editor
- Open the editor or unity hub, from there open the source code as a project.
- Wait for the project to be loaded in and all dependencies fetched.
- **Make all desired modifications.**
- Ensure the project builds with no errors.
- Open the projects tab.
- Right-click on the Assets Folder in the Project tab. (Or click on the Assets folder in the project tab,
selecting it and then click on Assets in the main menu bar)
- Select Export Package.
- Check the boxes of all required Items.
- Deselect Include dependencies (so it doesn't pack unity version dependent files)
- Select Include all scripts
- Click on Export
- Name the package and specify location to export package to.


## Build from command line


## Build using CI
File renamed without changes.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,9 @@ Starknet Unity SDK lets game developers integrate Starknet blockchain functional

1. Download the [latest release](https://github.com/NethermindEth/starknet.unity/releases) from this repository.
2. Import the package into your Unity project.
3. Follow the integration instructions provided in our [documentation](Docs/Documentation.md).
3. Follow the integration instructions provided in our [documentation](Docs/INSTALL.md).

## Build
1. Downdload the source code
2. Open the code in unity
3. Follow the instruction provided in [documentation](Docs/BUILD.md)