fixed nan propogation error
[carveJwlIkooP6JGAAIwe30JlM.git] / web / workshop / guide.html
1 <!DOCTYPE html>
2 <html>
3 <head>
4 <style type="text/css">
5 body{
6 margin:40px auto;
7 max-width:650px;
8 line-height:1.6;
9 font-size:18px;
10 color:#444;
11 padding:0 10px
12 }
13 h1,h2,h3{line-height:1.2}
14 </style>
15 </head>
16
17 <body>
18 <h1>Workshop Guide - Custom boards</h1>
19 <p>This guide covers creating a custom board model using blender and an image
20 editor. Since theres not many of us here at the moment, feel free to contact
21 me at <i>hgodden00@gmail.com</i> for any help.</p>
22
23 <h2>0. Things you need</h2>
24 <p>- Skaterift content is made using Blender. You can get the latest version
25 of <a href="https://store.steampowered.com/app/365670/Blender/">
26 Blender from steam</a>, this guide is for version 3.4 and above.<br>
27 - <a href="https://www.gimp.org/">GNU Gimp</a> or similar image editor.<br>
28 - Download the <a href="custom_board.zip">custom_board.zip</a><br>
29 - An installed copy of Skaterift of course.</p>
30 <hr>
31
32 <h2>1. Installing exporter addon</h2>
33 <p>Skaterift comes with the addon in its game files, we just need to install
34 it. This addon script gets updated between skaterift versions. Here are the
35 steps to install it into Blender:<br>
36 <br>
37 Go to <b>edit&gt;preferences</b>, and open the <b>addons section.</b><br>
38 <br>
39 Press the <b>install...</b> button at the top right, and browse to the
40 Skaterift game files. Inside the folder named <b>tools</b> is the script
41 <b>blender_export.py</b> to install.<br>
42 <br>
43 If you don't know where it is, you can go into your Steam Library, and
44 rightclick Skaterift, selecting <b>Manage&gt;Browse local files.</b><br>
45 <br>
46 Now just search for Skaterift .mdl exporter from the addons list, and enable
47 it.<br>
48 <hr>
49
50 <h2>2. Configuring the template</h2>
51 <p>Firstly, Open the .blend file from the board_template zip.<br>
52 <br>
53 Open the side panel in the 3D Viewport, and find the Skaterift tab, and in
54 that menu, the <b>Export tab</b><br>
55 <br>
56 <b>Export Dir</b> must be set to the game folder, which ends in
57 <i>/steamapps/common/skaterift<b>/</b></i><br>
58 <b>NOTE:</b> the path must have a
59 <b>/</b> at the end, else things will break.<br>
60 <br>
61 Wer're now setup to go, but an optional step here is to create one from
62 scratch. If you want to do this, <a href="board_spec.html">take a look at the
63 detailed board specification</a> for how to set it up. If its your first one,
64 you probably want to skip this step.</p>
65 <hr>
66
67 <h2>3. Edit the texture</h2>
68 <p>Next step is to customize the artwork, in the template folder there is a
69 texture which you can edit. There is also the original .xcf file which you can
70 open using <a href="https://www.gimp.org/">GNU Gimp</a>, or a similar image
71 editor.<br>
72 <img src="guide2.jpg" width="100%"/>
73 Now you can change the texture on the material to your own file, and see how
74 it looks in Blender.
75 <img src="guide1.jpg" width="100%"/>
76 </p>
77 <hr>
78
79 <h2>4. Compile the model</h2>
80 <p>In the <b>Outliner</b> panel in the top right, rename the collection name,
81 called <i>boards/template/board.mdl</i>. You should replace only the word
82 <b></i>template</i></b>. The collection name is the path it will export the
83 model, relative to the directory we set earlier.<br>
84 <br>
85 Now in the Skaterift Export tab, press Compile This collection. <b>NOTE:
86 Blender will freeze for a second or so, since the export script has to
87 compress the texture file.</b><br>
88 </p>
89 <hr>
90
91 <h2>5. Test it out in-game</h2>
92 <p>If everything is good, you should be able to visit the board shop and it
93 will be loaded in there. If not, try reopen it. If still not not, then
94 something broke, and there is no contingency plan here, sorry.<br>
95 </p>
96 <hr>
97
98 <h2>6. Upload via the Workshop tool</h2>
99 <p>From the menu of Skaterift, you can open the
100 workshop tool. From here, fill in the folder name which houses the board. This
101 is relative to the game folder just like the export tool. You will know its
102 correct when you see your board after pressing the load button.<br>
103 <img src="guide3.jpg" width="100%"/>
104 <br>
105 You can customize the preview by dragging around the image, left, right and
106 middle mouse buttons do different controls.
107 From here, just fill in the information like the title and description, and
108 press submit.
109 </p>
110 </body>
111 </html>