Differences

This shows you the differences between two versions of the page.

--- steam_workshop [2025/02/20 21:52] – justin
+++ steam_workshop [2025/02/28 14:49] (current) – justin
@@ Line 1: / Line 1: @@
 ======Steam Workshop======
 ----
-Welcome to the RPG in a Box Steam Workshop documentation! Below you will find links to some step-by-step guides covering each aspect of using the workshop.
+Welcome to the RPG in a Box Steam Workshop documentation!
+Want to jump right in and start sharing your creations with the community? Check out Stumpy's quick start guide for a brief walkthrough of how to share models to the workshop.
+**Stumpy's Quick Start Guide:** [[https://youtu.be/EX7UVjw0bZE]]
+{{:workshop_quick_start_guide.png?nolink|}}
+Below you will find links to some in-depth, step-by-step guides covering each aspect of using the workshop.
 **[[#publishing_a_new_asset_step-by-step_guide|Publishing a New Asset (Step-by-Step Guide)]]**\\
@@ Line 149: / Line 157: @@
 =====Downloading Assets (Step-by-Step Guide)=====
-- Downloading assets from the workshop and into your game project is very simple! First, go to the RPG in a Box Steam Workshop to view everything that’s been uploaded by the community. A button is available within RPG in a Box to open the workshop in your Steam client (as mentioned in the next step), or you can go to the Community Hub for RPG in a Box on Steam and click the “Workshop” tab at the top. Assets can be filtered by clicking on a type (Tile, Object, or Character) on the right-hand side of the page under “Asset Type”.
+Downloading assets from the workshop and into your game project is very simple! First, go to the RPG in a Box Steam Workshop to view everything that’s been uploaded by the community. A button is available within RPG in a Box to open the workshop in your Steam client (as mentioned in the next step), or you can go to the Community Hub for RPG in a Box on Steam and click the “Workshop” tab at the top. Assets can be filtered by clicking on a type (Tile, Object, or Character) on the right-hand side of the page under “Asset Type”.
+{{:workshop_assets_page.png?nolink|}}
+Clicking on an asset’s preview will take you to the detail page for it. From there, click the green “Subscribe” button to subscribe to the asset. Once subscribed, Steam will automatically download the asset so that it’s available to RPG in a Box.
-- Clicking on an asset’s preview will take you to the detail page for it. From there, click the green “Subscribe” button to subscribe to the asset. Once subscribed, Steam will automatically download the asset so that it’s available to RPG in a Box.
+{{:acorn_subscribed.png?nolink|}}
+Next, open your project in RPG in a Box, then click the "Import Assets" button on the main toolbar along the top of the application. Choose “Steam Workshop” from the dropdown menu. This will open the Steam Workshop tab of the “Import Assets” dialog.
+{{:import_assets_menu.png?nolink|}}
-- Next, open your project in RPG in a Box, then click the "Import Assets" button on the main toolbar along the top of the application. Choose “Steam Workshop” from the dropdown menu. This will open the Steam Workshop tab of the “Import Assets” dialog.
+Upon opening, it will automatically start populating the center section with preview images of any assets that you’re currently subscribed to.
+{{:import_from_workshop.png?nolink|}}
+If you were already on this tab when you subscribed to an asset, you can click the “Refresh” button at the top. You can easily return to the workshop in your Steam client by clicking the “View Workshop on Steam” button next to the “Refresh” button.
-- Upon opening, it will automatically start populating the center section with preview images of any assets that you’re currently subscribed to.
+{{:view_workshop_button.png?nolink|}}
+Hover over an asset to see a tooltip containing its title, or click on it to see its title and description in the bottom section of the dialog. When an asset it selected, you can click the "View on Workshop" button to open the workshop page for that asset in your Steam client.
+{{:workshop_asset_details.png?nolink|}}
-- If you were already on this tab when you subscribed to an asset, you can click the “Refresh” button at the top. You can easily return to the workshop in your Steam client by clicking the “View Workshop on Steam” button next to the “Refresh” button.
+Select one or more assets that you’d like to import into your game project. Holding the Ctrl key while clicking will allow you to select multiple assets.
+{{:models_selected.png?nolink|}}
+The two checkbox buttons at the bottom (next to the text showing the number of models selected) can be used to select everything at once or clear all of the selected models.
-- Hover over an asset to see a tooltip containing its title, or click on it to see its title and description in the bottom section of the dialog. When an asset it selected, you can click the "View on Workshop" button to open the workshop page for that asset in your Steam client.
+{{:select_toolbar.png?nolink|}}
+Once you’ve selected the desired assets, click the "Import" button at the bottom to import them into your project. A dialog will appear to display a list of files included with each asset. A warning icon will be displayed next to any assets that already exist in your project and will be overwritten. Click OK to proceed once you’ve checked the list of assets.
+{{:included_assets_dialog.png?nolink|}}
-- Select one or more assets that you’d like to import into your game project. Holding the Ctrl key while clicking will allow you to select multiple assets.
+Once the chosen assets have been downloaded and imported into your project, a dialog will appear indicating that it has completed successfully. You can now use them in your project! Be sure to give credit to anyone whose assets you’ve included in your game, especially if they’ve requested on their workshop page to be credited. Now go have fun making games with your newly downloaded assets!
-- The two checkbox buttons at the bottom (next to the text showing the number of models selected) can be used to select everything at once or clear all of the selected models.
-- Once you’ve selected the desired assets, click the "Import" button at the bottom to import them into your project. A dialog will appear to display a list of files included with each asset. A warning icon will be displayed next to any assets that already exist in your project and will be overwritten. Click OK to proceed once you’ve checked the list of assets.
-- Once the chosen assets have been downloaded and imported into your project, a dialog will appear indicating that it has completed successfully. You can now use them in your project! Be sure to give credit to anyone whose assets you’ve included in your game, especially if they’ve requested on their workshop page to be credited. Now go have fun making games with your newly downloaded assets!
 =====Deleting an Asset (Step-by-Step Guide)=====
-- Open your Steam profile page, then click “Workshop Items” on the sidebar to the right.
+Open your Steam profile page, then click “Workshop Items” on the sidebar to the right.
+{{:profile_workshop_items.png?nolink|}}
+Choose “RPG in a Box” from the “Filter by game” dropdown at the top.
-- Choose “RPG in a Box” from the “Filter by game” dropdown at the top.
+{{:workshop_game_filter.png?nolink|}}
+Find the asset that you’d like to delete, then click on it to open its detail page.
+In the “Owner Controls” section on the sidebar to the right, click “Delete”, then click OK to confirm. Please note that this is permanent and cannot be undone!
-- Find the asset that you’d like to delete, then click on it to open its detail page.
+{{:owner_controls.png?nolink|}}
-- In the “Owner Controls” section on the sidebar to the right, click “Delete”, then click OK to confirm. Please note that this is permanent and cannot be undone!
 =====Tips and Tricks=====
-- If you need help at any time while using the workshop, you can click the “Help” button on the applicable dialog. You can also find the step-by-step guides by searching either the online or built-in documentation for “workshop”.
+  * If you need help at any time while using the workshop, you can click the “Help” button on the applicable dialog. You can also find the step-by-step guides by searching either the online or built-in documentation for “workshop”.
-- Camera positions can be saved and loaded in the “Upload to Steam Workshop” dialog using the dropdown in the lower right corner of the main viewport, similar to the Model Maker. This can be particularly useful for maintaining a consistent camera angle for the preview images across different assets that you’re publishing to the workshop.
+  * Camera positions can be saved and loaded in the “Upload to Steam Workshop” dialog using the dropdown in the lower right corner of the main viewport, similar to the Model Maker (with which the camera positions are shared). This can be particularly useful for maintaining a consistent camera angle for the preview images across different assets that you’re publishing to the workshop.
-- You can view everything you’ve uploaded to the Steam Workshop by going to your Steam profile page then clicking “Workshop Items” on the sidebar. From that page, choose “RPG in a Box” from the “Filter by game” dropdown at the top.
+  * You can view everything you’ve uploaded to the Steam Workshop by going to your Steam profile page then clicking “Workshop Items” on the sidebar. From that page, choose “RPG in a Box” from the “Filter by game” dropdown at the top.
-- Collections can be created on the Steam Workshop to organize a group of related assets together (e.g. a set of tiles and objects you’ve uploaded belonging to a dungeon tileset). To create a collection, go to an asset on the workshop, then click the “Add to Collection” button. If you don’t have any collections yet, the prompt will include a link for creating one. You can view the community’s workshop collections for RPG in a Box by clicking the “Browse” button at the top of the Steam Workshop then choosing “Collections” or by visiting this link.
+  * Collections can be created on the Steam Workshop to organize a group of related assets together (e.g. a set of tiles and objects you’ve uploaded belonging to a dungeon tileset). To create a collection, go to an asset on the workshop, then click the “Add to Collection” button. If you don’t have any collections yet, the prompt will include a link for creating one. You can view the community’s workshop collections for RPG in a Box by clicking the “Browse” button at the top of the Steam Workshop then choosing “Collections” or by visiting this link.
-- Although it’s recommended to keep your assets public so they’re available to everyone in the community, you can change an asset’s visibility from its detail page on the Steam Workshop after it’s been published (e.g. “Friends Only” if it’s something made exclusively for a project you’re working on together with your friends).
+  * Although it’s recommended to keep your assets public so they’re available to everyone in the community, you can change an asset’s visibility from its detail page on the Steam Workshop after it’s been published (e.g. “Friends Only” if it’s something made exclusively for a project you’re working on together with your friends).
 ~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Differences

Page Tools

RPG in a Box
Official Documentation