Skip to content

QPM-Rust v2 update #473

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

QPM-Rust v2 update #473

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ecaf28
QPM-Rust v2
Fernthedev Nov 27, 2022
1f7dc9a
Better language
Fernthedev Nov 27, 2022
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
31 changes: 28 additions & 3 deletions wiki/modding/quest-mod-dev-intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,28 @@ 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.

Windows users may use the installer instead.

### Ninja

#### QPM-Rust v2
`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.
Expand All @@ -61,8 +73,21 @@ 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`

#### Manual

[Download the Android NDK](https://developer.android.com/ndk), unzip it and add it to your PATH variable.

## Create a Project
Expand All @@ -71,7 +96,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.
Expand Down Expand Up @@ -104,7 +129,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.
Expand Down