add world entities
[carveJwlIkooP6JGAAIwe30JlM.git] / web / frag / workshop_board.html
1 <div class="subcontent" style="background-color:var(--k_ui_bg4)">
2 <center><h1>Workshop Guide - Custom boards</h1></center>
3 <p>This guide covers creating a custom board model using blender and an image
4 editor. Since theres not many of us here at the moment, feel free to contact
5 me at <i>hgodden00@gmail.com</i> for any help.</p>
6 </div>
7 <div class="subcontent">
8 <h2>0. Things you need</h2>
9 <p>- Skaterift content is made using Blender. You can get the latest version
10 of <a href="https://store.steampowered.com/app/365670/Blender/">
11 Blender from steam</a><br>
12 - <a href="https://www.gimp.org/">GNU Gimp</a> or similar image editor.<br>
13 - Download the <a href="files/custom_board.zip">custom_board.zip</a><br>
14 - An installed copy of Skaterift of course.</p>
15 </div>
16 <div class="subcontent">
17 <h2>1. Installing exporter addon</h2>
18 <p>Skip this step if you've already done it before.
19 <a href="index.php?page=addon">Guide on how to install the exporter addon for
20 Blender</a>
21 </p>
22 </div>
23 <div class="subcontent">
24 <h2>2. Configuring the template</h2>
25 <p>Firstly, Open the .blend file from the board_template zip.<br>
26 <br>
27 Open the side panel in the 3D Viewport, and find the Skaterift tab, and in
28 that menu, the <b>Export tab</b><br>
29 <br>
30 <b>Export Dir</b> must be set to the game folder, which ends in
31 <i>/steamapps/common/skaterift<b>/</b></i><br>
32 <b style="color:var(--k_ui_red1)">NOTE</b>:<i style="color:var(--k_ui_fg4)">
33 the path must have a <b>/</b> at the end, else things will break.</i><br>
34 <br>
35 Wer're now setup to go, but an optional step here is to create one from
36 scratch. If you want to do this, <a href="index.php?page=board_spec">
37 take a look at the detailed board specification</a> for how to set it up.
38 If its your first one, you probably want to skip this step.</p>
39 </div>
40 <div class="subcontent">
41 <h2>3. Edit the texture</h2>
42 <p>Next step is to customize the artwork, in the template folder there is a
43 texture which you can edit. There is also the original .xcf file which you can
44 open using <a href="https://www.gimp.org/">GNU Gimp</a>, or a similar image
45 editor.<br><br>
46 <img src="img/guide2.jpg" width="100%"/><br>
47 Now you can change the texture on the material to your own file, and see how
48 it looks in Blender.<br><br>
49 <img src="img/guide1.jpg" width="100%"/><br>
50 </p>
51 </div>
52 <div class="subcontent">
53 <h2>4. Compile the model</h2>
54 <p>In the <b>Outliner</b> panel in the top right, rename the collection name,
55 called <i>boards/template/board.mdl</i>. You should replace only the word
56 <b></i>template</i></b>. The collection name is the path it will export the
57 model, relative to the directory we set earlier.<br>
58 <br>
59 Now in the Skaterift Export tab, press Compile This collection.
60 <br>
61 <b style="color:var(--k_ui_red1)">NOTE</b>:<i style="color:var(--k_ui_fg4)">
62 Blender will freeze for a second or so, since the export script has to
63 compress the texture file.</i><br>
64 </p>
65 </div>
66 <div class="subcontent">
67 <h2>5. Test it out in-game</h2>
68 <p>If everything is good, you should be able to visit the board shop and it
69 will be loaded in there. If not, try reopen it. If still not not, then
70 something broke, and there is no contingency plan here, sorry.<br>
71 </p>
72 </div>
73 <div class="subcontent">
74 <h2>6. Upload via the Workshop tool</h2>
75 <p>From the menu of Skaterift, you can open the
76 workshop tool. From here, fill in the folder name which houses the board. This
77 is relative to the game folder just like the export tool. You will know its
78 correct when you see your board after pressing the load button.<br>
79 <img src="img/guide3.jpg" width="100%"/>
80 <br>
81 You can customize the preview by dragging around the image, left, right and
82 middle mouse buttons do different controls.
83 From here, just fill in the information like the title and description, and
84 press submit.
85 </p>
86 </div>