Skip to content
Merged
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
22 changes: 16 additions & 6 deletions content/getting_started/quickstart/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
+++
title = "Setup"
description = "Setup"
title = "Setup or Upgrade"
description = "Setup or Upgrade"
weight = 2
date= 2024-10-19
+++

Welcome to ProPixelizer, let's get started!

## Setting up a new project

Make sure you have the Universal Render Pipeline package added to the project (if not, you can add this using the Unity Package Manager).

## 1. Import ProPixelizer
### 1. Import ProPixelizer

Import ProPixelizer from the Unity Package Manager; it must be located at Assets/ProPixelizer, which is the default location Unity suggests.

## 2. Find your Render Pipeline Asset(s)
### 2. Find your Render Pipeline Asset(s)

Universal Render Pipeline stores your project's graphical configuration in a Render Pipeline Asset.
These assets are commonly stored in Assets/Settings.
Expand All @@ -22,7 +26,7 @@ Please note that your project very likely has multiple Render Pipeline Assets, a

![demonstration of project quality settings](project_quality_settings.png "Quality Settings")

## 3. Configure your Render Pipeline Asset(s)
### 3. Configure your Render Pipeline Asset(s)

You can now add ProPixelizer to each Render Pipeline Asset that you are using.

Expand All @@ -34,7 +38,13 @@ You can now add ProPixelizer to each Render Pipeline Asset that you are using.

![example renderer](renderer.png)

## 4. Check out the examples!
## Upgrading from an older version

If your project is already using a previous version of ProPixelizer which was imported into your Project's `Assets` folder, **please delete this old version first** and then import the new version using the Unity Package Manager. The new version will be installed to `Packages/ProPixelizer`.

ProPixelizer uses the same `.meta` files for all assets and source files between versions and so your project will automatically use the updated scripts, Monobehaviors and assets from the new package version. For more detailed update notes and version history, see the [changelog](@/versions/changelog/index.md) and [update guide](@/versions/updating_from_prev/index.md).

## Check out the examples!

You have now configured your project for ProPixelizer.
The [example scenes](../examples) show you lots of interesting things you can do with ProPixelizer, and showcase various features of the plugin, so I recommend taking a look!
Expand Down
5 changes: 3 additions & 2 deletions content/landing/_index.md → content/welcome/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ render = true

![propixelizer vehicle](AnimatedVehicle.gif)

Welcome to ProPixelizer!
Welcome to ProPixelizer's documentation!

- Use the navigation at the side to see what topics are available.
- For setting up a new project, see the [Quick Start](@/getting_started/quickstart/index.md) guide.
- Check out the [examples](@/getting_started/examples/index.md) for hands-on demos.
- For a more detailed description of how to use the package, start with the [overview](@/usage/overview/index.md).

I hope you enjoy using ProPixelizer. Please do message me if you have any questions or problems. I'm always very pleased to hear what you make with it!

Expand Down
2 changes: 1 addition & 1 deletion themes/zola_easydocs_theme