From f31306e19bd85dcb6812c30c9a5f37de2801c329 Mon Sep 17 00:00:00 2001 From: Osakpolor Obaseki Date: Tue, 26 Nov 2024 14:47:39 +0100 Subject: [PATCH 1/5] update links and add build docs --- Docs/BUILD.md | 0 Docs/{Documentation.md => INSTALL.md} | 0 README.md | 7 ++++++- 3 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 Docs/BUILD.md rename Docs/{Documentation.md => INSTALL.md} (100%) diff --git a/Docs/BUILD.md b/Docs/BUILD.md new file mode 100644 index 0000000..e69de29 diff --git a/Docs/Documentation.md b/Docs/INSTALL.md similarity index 100% rename from Docs/Documentation.md rename to Docs/INSTALL.md diff --git a/README.md b/README.md index 6ad0774..d1f20d8 100644 --- a/README.md +++ b/README.md @@ -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) \ No newline at end of file From cc291b0465e43b68ab607237422883d9805ddd13 Mon Sep 17 00:00:00 2001 From: Osakpolor Obaseki Date: Wed, 27 Nov 2024 12:02:41 +0100 Subject: [PATCH 2/5] Update: manually building project. --- Docs/BUILD.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/Docs/BUILD.md b/Docs/BUILD.md index e69de29..a46db22 100644 --- a/Docs/BUILD.md +++ b/Docs/BUILD.md @@ -0,0 +1,32 @@ +# 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. + + +Or + +## Build from command line From f8e2230e1bb0c6b62f8212d6912c4daaab0a646c Mon Sep 17 00:00:00 2001 From: Osakpolor Obaseki Date: Wed, 27 Nov 2024 12:06:15 +0100 Subject: [PATCH 3/5] Add ci --- Docs/BUILD.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Docs/BUILD.md b/Docs/BUILD.md index a46db22..76e04cd 100644 --- a/Docs/BUILD.md +++ b/Docs/BUILD.md @@ -30,3 +30,6 @@ selecting it and then click on Assets in the main menu bar) Or ## Build from command line + + +## Build using CI \ No newline at end of file From 4dffda1597bfe44e8e37d377552286011a814160 Mon Sep 17 00:00:00 2001 From: Osakpolor Obaseki Date: Wed, 27 Nov 2024 12:08:59 +0100 Subject: [PATCH 4/5] Fix type --- Docs/BUILD.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/Docs/BUILD.md b/Docs/BUILD.md index 76e04cd..840b1d8 100644 --- a/Docs/BUILD.md +++ b/Docs/BUILD.md @@ -27,8 +27,6 @@ selecting it and then click on Assets in the main menu bar) - Name the package and specify location to export package to. -Or - ## Build from command line From 7389520035c932b6734b74736292c49f865de962 Mon Sep 17 00:00:00 2001 From: Osakpolor Obaseki Date: Wed, 27 Nov 2024 12:09:54 +0100 Subject: [PATCH 5/5] Fix formatting --- Docs/BUILD.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Docs/BUILD.md b/Docs/BUILD.md index 840b1d8..350ca08 100644 --- a/Docs/BUILD.md +++ b/Docs/BUILD.md @@ -14,7 +14,7 @@ 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. +- **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,