SteelStudio: New Docs

docs/steel-studio/_category_.json

@@ -1,5 +1,5 @@
 {
-  "label": "Steel Studio",
+  "label": "Steel Studio v0.5",
   "position": 3,
   "link": {
     "type": "generated-index",

docs/steel-studio/backgrounds.mdx

@@ -0,0 +1,20 @@
+---
+sidebar_position: 3
+title: Backgrounds
+description: Backgrounds tab of Steel Studio
+---
+import VideoPlayer from '@site/src/components/VideoPlayer'
+import videoThemeSelection from './video/background_colors.mp4';
+
+# Backgrounds
+
+The Backgrounds tab in Steel Studio allows you to choose a color for every defined materials in the showroom. 
+Every showroom can have a set of customizable backgrounds, so you are free to choose the color you want.
+
+#### Here you can:
+
+- Click on a **Color Palette** and change hue, saturation, lightness, or specify RGB/HSL/HEX colors.
+- Click the button **Shuffle Palette** to pick random colors for every palette
+- ~~Add a new color controller~~ <mark>Not available, under development</mark>
+
+<VideoPlayer url={videoThemeSelection} />

docs/steel-studio/extra.mdx

@@ -0,0 +1,20 @@
+---
+sidebar_position: 6
+title: Extra
+description: Extra tab of Steel Studio
+---
+import VideoPlayer from '@site/src/components/VideoPlayer'
+import videoThemeSelection from './video/extra_tools.mp4';
+
+# Extra
+
+The Extra tab in Steel Studio allows you change userful things to make your shots even better. \
+This is a quick way to hide crew, drivers and disable audio.
+
+#### Here you can:
+
+- **Disable audio** of the game (<mark>Important:</mark> this setting is saved, remember to check it next time you open your game)
+- **Hide Pit Crew**, so you don't have to use extra files or replace it.
+- **Hide Drivers**, just a quick shortcut to hide drivers.
+
+<VideoPlayer url={videoThemeSelection} />

docs/steel-studio/intro.md

@@ -9,5 +9,11 @@ Introducing Steel Studio, the ultimate extension for your showroom customization
 Steel Studio takes your customization experience to the next level, offering intuitive tools and features that give you complete control over your showroom environment. Whether you want to tweak the lighting, modify the backdrop, or highlight specific elements, Steel Studio provides the flexibility and precision needed to bring your vision to life.
 
 :::warning
-**This section is a Work In Progress and will be updated soon. Come check again to know more about Steel Studio!**
-:::
+**Steel Studio is Work In Progress and will be updated soon. Come check again to know more about Steel Studio!**
+:::
+
+
+
+### Links
+
+- [SteelStudio Github Page](https://github.com/steel89ita/ac_steel_studio)

docs/steel-studio/objects.mdx

@@ -0,0 +1,20 @@
+---
+sidebar_position: 5
+title: Objects
+description: Objects tab of Steel Studio
+---
+import VideoPlayer from '@site/src/components/VideoPlayer'
+import videoThemeSelection from './video/objects_control.mp4';
+
+# Objects
+
+The Objects tab in Steel Studio allows you to hide and show defined objects in the track. \
+This is a quick way to show and hide them without the need to restart the game.
+
+#### Here you can:
+
+- Select which defined object to show or hide
+- Save Objects to save the changes. When you restart the game and open Steel Studio you will restore the visibility as it was saved.
+- Your objects are saved in the ```[track_folder]/extension/steelstudio/objects.json```, so you can share them with anyone.
+
+<VideoPlayer url={videoThemeSelection} />

docs/steel-studio/teleport.mdx

@@ -0,0 +1,22 @@
+---
+sidebar_position: 4
+title: Teleport
+description: Teleport tab of Steel Studio
+---
+import VideoPlayer from '@site/src/components/VideoPlayer'
+import videoThemeSelection from './video/teleport_car.mp4';
+
+# Teleport
+
+The Teleport tab in Steel Studio allows you to teleport your car in default and saved locations, or flip car orientation. 
+This is a quick way to save your desired locations and use them again later.
+
+#### Here you can:
+
+- Add the current location by naming it in the input field and clicking **Add Location**
+- **Remember**: click the <span class="text--success">**Save Locations**</span> button before closing ACT or Steel Studio.
+- Click the Teleport to Starting Line / Hotlap Start or Pits to teleport to the default track locations.
+- Click the <span class="text--info">**Flip Car Direction**</span> button to rotate the car by 180 degrees.
+- Your locations are saved in the ```[track_folder]/extension/steelstudio/locations.json```, so you can share them with anyone.
+
+<VideoPlayer url={videoThemeSelection} />

docs/steel-studio/themes.mdx

@@ -1,5 +1,7 @@
 ---
 sidebar_position: 2
+title: Themes
+description: Themes tab of Steel Studio
 ---
 import VideoPlayer from '@site/src/components/VideoPlayer'
 import videoThemeSelection from './video/themes_selection.mp4';
@@ -13,6 +15,7 @@ This feature provides a seamless way to customize the visual appeal of your scen
 #### Here you can:
 
 - Choose a saved palette or delete it.
-- Inser a name in the _input box_ and **Save current theme** to save your chosen background colors and use again later.
+- Insert a name in the _input box_ and **Save current theme** to save your chosen **background colors** and use again later.
+- Your themes are saved in the ```[track_folder]/extension/steelstudio/theme_[name].json```, so you can share them with anyone.
 
 <VideoPlayer url={videoThemeSelection} />

docs/steel-studio/track-configs/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Advanced Configuration",
-  "position": 3,
+  "position": 999,
   "link": {
     "type": "generated-index",
     "description": "Learn how to use and configure Steel Studio."

docs/steel-studio/track-configs/advanced_objects.mdx

@@ -0,0 +1,52 @@
+---
+title: Objects Config
+description: Configuration of the Objects file
+sidebar_position: 3
+---
+
+{/* Ext Config INI parts */}
+import ObjectsTemplate from '!!raw-loader!@site/src/configs/steelstudio/objects.json';
+
+import StCodeBlock from '@site/src/components/StCodeBlock'
+import PropsTable from '@site/src/components/PropsTable'
+
+export const objectsProperties = [
+    { name: 'meshNames', desc: 'String Array of the meshes to control visibility', vals: 'Array of String' },
+    { name: 'name', desc: 'Label of the objects seen in the app', vals: 'String' },
+    { name: 'enabled', desc: 'Default visibility', vals: 'true | false' }
+]
+
+export const backgroundsProperties = [
+    { name: 'color', desc: 'RGBA colors, comma separated', vals: '0-1, 0-1, 0-1, 0-1' },
+    { name: 'texture', desc: 'Texture type (role) to replace', vals: 'String ( txDiffuse | txDetail | ... )' },
+    { name: 'meshNames', desc: 'Array containing one or more meshes with the material to replace the texture', vals: 'Array of Strings' },
+    { name: 'label', desc: 'Name of the palette shown in Steel Studio', vals: 'String' },
+]
+
+# Locations Config
+
+
+:::warning
+When you **Save Objects** from the Steel Studio app, this file is saved so that the next time the visibility is kept.
+:::
+
+:::info
+You can specify Mesh names like in CSP configs with **? (question mark)** to select more objects with similar name
+:::
+
+
+### Config file properties
+
+<StCodeBlock title={'extension/steelstudio/objects.json'} language={'json'} >
+    {ObjectsTemplate}
+</StCodeBlock>
+
+<PropsTable rows={objectsProperties} />
+
+
+
+
+
+
+
+

docs/steel-studio/track-configs/advanced_teleport.mdx

@@ -0,0 +1,49 @@
+---
+title: Locations Config
+description: Configuration of the Locations file
+sidebar_position: 2
+---
+
+{/* Ext Config INI parts */}
+import LocationsTemplate from '!!raw-loader!@site/src/configs/steelstudio/locations.json';
+
+import StCodeBlock from '@site/src/components/StCodeBlock'
+import PropsTable from '@site/src/components/PropsTable'
+
+export const locationsProperties = [
+    { name: 'look', desc: 'Comma separated string where the car is looking at', vals: 'String' },
+    { name: 'position', desc: 'Comma separated string where the car is located', vals: 'String' },
+    { name: 'name', desc: 'Label of the button of the location seen in the app', vals: 'String' }
+]
+
+export const backgroundsProperties = [
+    { name: 'color', desc: 'RGBA colors, comma separated', vals: '0-1, 0-1, 0-1, 0-1' },
+    { name: 'texture', desc: 'Texture type (role) to replace', vals: 'String ( txDiffuse | txDetail | ... )' },
+    { name: 'meshNames', desc: 'Array containing one or more meshes with the material to replace the texture', vals: 'Array of Strings' },
+    { name: 'label', desc: 'Name of the palette shown in Steel Studio', vals: 'String' },
+]
+
+# Locations Config
+
+
+:::warning
+This file can be saved from the Teleport tab. You don't need to configure it manually.\
+**Just use this as a reference or if you need to change the location name.**
+:::
+
+
+### Config file properties
+
+<StCodeBlock title={'extension/steelstudio/locations.json'} language={'json'} >
+    {LocationsTemplate}
+</StCodeBlock>
+
+<PropsTable rows={locationsProperties} />
+
+
+
+
+
+
+
+

docs/steel-studio/track-configs/advanced_themes.mdx

@@ -0,0 +1,65 @@
+---
+title: Theme Config
+description: Configuration of the Theme file
+sidebar_position: 1
+---
+
+{/* Ext Config INI parts */}
+import ThemesTemplate from '!!raw-loader!@site/src/configs/steelstudio/theme_00_default.json';
+import ExtLightsControl from '!!raw-loader!@site/src/configs/st_02_ext_lights.ini';
+
+import StCodeBlock from '@site/src/components/StCodeBlock'
+import PropsTable from '@site/src/components/PropsTable'
+
+export const themeProperties = [
+    { name: 'theme', desc: 'Theme name seen in the Theme selection button', vals: 'String' },
+    { name: 'backgrounds', desc: 'Array containing the color palettes', vals: 'Array' }
+]
+
+export const backgroundsProperties = [
+    { name: 'color', desc: 'RGBA colors, comma separated', vals: '0-1, 0-1, 0-1, 0-1' },
+    { name: 'texture', desc: 'Texture type (role) to replace', vals: 'String ( txDiffuse | txDetail | ... )' },
+    { name: 'meshNames', desc: 'Array containing one or more meshes with the material to replace the texture', vals: 'Array of String' },
+    { name: 'label', desc: 'Name of the palette shown in Steel Studio', vals: 'String' },
+]
+
+# Theme Config
+
+
+### How to create this config
+
+1. Copy this config file from the template and paste it in ```[track_folder]/extension/steelstudio```
+1. In the CSP Objects Inspector app, **Select a mesh** and **copy it's name**.
+2. Look at the **Textures tab** and choose the Texture type you want to override 
+    - for simple meshes, it's normally txDiffuse
+    - for more complex ones, you might want to select txDetail
+3. **Edit** the first object by replacing the content in meshNames and texture.
+4. **Save** the file. Reopen Steel Studio, **select the theme** then try to change the palette.
+
+:::info
+Actually, you need to specify the mesh that has the material you need to change the texture.\
+**For example,** you can specify two meshes that have different materials to change the color on both materials.
+:::
+
+### Config file properties
+
+<StCodeBlock title={'extension/steelstudio/theme_00_default.json'} language={'json'} >
+    {ThemesTemplate}
+</StCodeBlock>
+
+
+
+
+<PropsTable rows={themeProperties} />
+
+### Backgrounds Array properties
+
+<PropsTable rows={backgroundsProperties} />
+
+
+
+
+
+
+
+

docs/steel-studio/track-configs/download_template.mdx

@@ -0,0 +1,29 @@
+---
+title: Download Template
+description: Download Configs Template
+sidebar_position: 4
+---
+import DownloadButton from '@site/src/components/DownloadButton'
+import ConfigLink from '@site/src/configs/steelstudio/steelstudio_configs_v0.5.zip'
+
+# Download Config Template
+
+This template helps you configure your showroom/track to work with Steel Studio.\
+Start by copying its contents to your ```[track_folder]/extension/steelstudio``` folder.
+
+### [Download Steel Studio Config Template v.0.5](@site/src/configs/steelstudio/steelstudio_configs_v0.5.zip)
+
+<DownloadButton link={ConfigLink}>
+Download Steel Studio Config Template v.0.5
+
+</DownloadButton>
+
+
+
+
+
+
+
+
+
+