From 5ecaf28092a5a4e14af639353966ef94f1e96e22 Mon Sep 17 00:00:00 2001 From: FernTheDev <15272073+Fernthedev@users.noreply.github.com> Date: Sat, 26 Nov 2022 22:24:19 -0400 Subject: [PATCH 1/2] QPM-Rust v2 --- wiki/modding/quest-mod-dev-intro.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/wiki/modding/quest-mod-dev-intro.md b/wiki/modding/quest-mod-dev-intro.md index 118a8e61e..6eae1e2d5 100644 --- a/wiki/modding/quest-mod-dev-intro.md +++ b/wiki/modding/quest-mod-dev-intro.md @@ -37,16 +37,26 @@ The following pieces of software are needed to follow this guide. ### QPM Rust -[Download the latest QPM Rust binary for your system](https://github.com/RedBrumbler/QuestPackageManager-Rust) from the +[Download the latest QPM Rust binary for your system](https://github.com/QuestPackageManager/QPM.CLI) from the Actions tab and add it to your PATH variable. ### Ninja +#### QPM-Rust v2 +With qpm-rust v2, you can run `qpm-rust download ninja`, which will download `ninja` and place it within the same folder `qpm-rust` resides in. + +#### Old method + [Download the latest Ninja binary for your system](https://github.com/ninja-build/ninja/releases) from the Releases tab and add it to your PATH variable. ### Templatr +#### QPM-Rust v2 +QPM-Rust v2 now bundles `templatr` within itself, and can be invoked through `qpm-rust templatr` + +#### Standalone + You can download the [latest release here.](https://github.com/QuestPackageManager/templatr/actions) Click the most recent build, than scroll down and download the artifact for your OS. @@ -61,8 +71,18 @@ To check if `templatr` was installed, run the help command in Powershell. templatr --help ``` +### CMake +CMake is generally easy to install on any OS it supports. Windows has installers and Linux through package repositories. However, QPM-Rust also allows for installing CMake and adding it to path automatically. +`qpm-rust download cmake` (May possibly not work on Linux or Mac) + ### Android NDK +#### QPM-Rust v2 +QPM-Rust v2 supports downloading and listing available NDK archives for your current OS. See `qpm-rust ndk` for more details. + +Example: +`qpm-rust ndk download 25.1.8937393` + [Download the Android NDK](https://developer.android.com/ndk), unzip it and add it to your PATH variable. ## Create a Project @@ -71,7 +91,7 @@ Once you have setup your environment you can now generate a mod template. The te [Lauriethefish](https://github.com/Lauriethefish/quest-mod-template). To start run the following command in Powershell. ```powershell -templatr use Lauriethefish/quest-mod-template +[qpm-rust] templatr use Lauriethefish/quest-mod-template ``` Templatr will then ask a series of questions to create a mod project. @@ -104,7 +124,7 @@ In a Powershell terminal in the project directory run: qpm-rust restore ``` -### Migrate from qpm to qpm-rust +### Migrate from qpm to qpm-rust (No longer required) If you had an install of qpm before following this guide and want to migrate to qpm-rust, you will need to fix the cache paths for old dependencies (such as codegen before Beat Saber version 1.17.0) by running the following command in the project directory. From 1f7dc9a136f40adfe5bc2b2e49a2b404bbd74035 Mon Sep 17 00:00:00 2001 From: FernTheDev <15272073+Fernthedev@users.noreply.github.com> Date: Sat, 26 Nov 2022 22:37:03 -0400 Subject: [PATCH 2/2] Better language --- wiki/modding/quest-mod-dev-intro.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/wiki/modding/quest-mod-dev-intro.md b/wiki/modding/quest-mod-dev-intro.md index 6eae1e2d5..1804c4bdb 100644 --- a/wiki/modding/quest-mod-dev-intro.md +++ b/wiki/modding/quest-mod-dev-intro.md @@ -40,10 +40,12 @@ The following pieces of software are needed to follow this guide. [Download the latest QPM Rust binary for your system](https://github.com/QuestPackageManager/QPM.CLI) from the Actions tab and add it to your PATH variable. +Windows users may use the installer instead. + ### Ninja #### QPM-Rust v2 -With qpm-rust v2, you can run `qpm-rust download ninja`, which will download `ninja` and place it within the same folder `qpm-rust` resides in. +`qpm-rust download ninja`, which will download `ninja` and place it within the same folder `qpm-rust` resides in. #### Old method @@ -53,7 +55,7 @@ and add it to your PATH variable. ### Templatr #### QPM-Rust v2 -QPM-Rust v2 now bundles `templatr` within itself, and can be invoked through `qpm-rust templatr` +QPM-Rust v2 now bundles `templatr` within itself, and can be invoked through `qpm-rust templatr`. #### Standalone @@ -73,6 +75,7 @@ templatr --help ### CMake CMake is generally easy to install on any OS it supports. Windows has installers and Linux through package repositories. However, QPM-Rust also allows for installing CMake and adding it to path automatically. + `qpm-rust download cmake` (May possibly not work on Linux or Mac) ### Android NDK @@ -83,6 +86,8 @@ QPM-Rust v2 supports downloading and listing available NDK archives for your cur Example: `qpm-rust ndk download 25.1.8937393` +#### Manual + [Download the Android NDK](https://developer.android.com/ndk), unzip it and add it to your PATH variable. ## Create a Project