How to set up an atelier store for your mod
This guide will detail how to add an Atelier store with your items. It is part of the Adding new items ArchiveXL tutorial, but you can complete these steps independently.
Find a guide on Your own inventory preview icons
Learn more about Game icons: The inkatlas file
If you are using ItemAdditions: Dynamic Appearances, you can use W's generator to quickly create spawn codes and Atelier entries
You need to install the VirtualAtelier mod for this.
You also have to add it to your mod's requirements, as atelier stores will cause script errors if users don't have it installed.
First of all, download the template archive (kindly provided by Apart) and find the folder virtual_atelier_inkatlas_icon_template
with the following files:
Put the .inkatlas and .xbm into your project (if you're using the example project, you can put them into the ops
folder). Then, rename them to atelier_icon
:
Now, create your icon. The process is the same as for "preview images". The resulting slot will be named slot_01
.
Visit this website and fill out the information:
Store ID (characters only, w/o spaces, '-', '_' and etc.)
MyTutorialAtelierStore
Store Name
My Tutorial Atelier Store
Atlas Resource
tutorial/torso/my_custom_shirt/ops/atelier_icon.inkatlas
Texture Part
slot_01
Now, add your item.
In atlasResource
, you have to replace all \
with /
Your atelier store will cause script errors if you don't.
Here's an explanation for the fields below. Rather than filling them by hand, you should use this website to generate your store files.
TweakDBID
as defined in your yaml, e.g.
Items.my_custom_shirt_redwhite
Price
Whatever price you want, 0 means that it's free
Quality
Are we settling for anything but legendary here?
Allowed values are:
- "IconicItem"
- "Legendary"
(LegendaryPlus, LegendaryPlusPlus)
- "Epic"
(EpicPlus)
- "Rare"
(RarePlus)
- "Uncommon"
(UncommonPlus)
- "Common"
(CommonPlus)
Ignore "Icon path" and "description", we have these in the item itself.
Click "Add Item". Repeat the process with as many items as you want.
Click "Generate".
In the downloaded file, check that atlasResource
has forward slashes /
instead of backwards slashes \
, as per the warning box above.
In your project's resources
folder, create a subdirectory r6/scripts (if it doesn't exist already), and move the atelier file that you downloaded into there:
Now, it's time to test! Install the mod and start Cyberpunk.
I'm not sure how you managed to read past all the red and yellow boxes on this page, but make sure that the path under atlasResource
has forward slashes /
instead of backwards slashes \
.
If that wasn't it, you might have to re-generate your Atelier store.
That happens when there are two atelier stores with the same store ID. Do a full-text search for the store ID (MyTutorialAtelierStore
) in r6\scripts
and make sure that you don't have any duplicates.