guides
authorhgn <hgodden00@gmail.com>
Fri, 2 Jun 2023 05:50:53 +0000 (06:50 +0100)
committerhgn <hgodden00@gmail.com>
Fri, 2 Jun 2023 05:50:53 +0000 (06:50 +0100)
web/board_spec.html [new file with mode: 0644]
web/guide.html

diff --git a/web/board_spec.html b/web/board_spec.html
new file mode 100644 (file)
index 0000000..f86fc77
--- /dev/null
@@ -0,0 +1,35 @@
+<!DOCTYPE html>
+<html>
+ <head>
+  <style type="text/css">
+   body{
+    margin:40px auto;
+    max-width:650px;
+    line-height:1.6;
+    font-size:18px;
+    color:#444;
+    padding:0 10px
+   }
+   h1,h2,h3{line-height:1.2}
+  </style>
+ </head>
+
+ <body>
+  <h1>Custom board specification</h1>
+  <p>Refer to this page if you want to make a completely new board from scratch,
+  otherwise use the template file.<br>
+  <br>
+  The board system looks for marker entities. These can be applied using the 
+  entity tab in the skaterift exporter panel.</p>
+  <h3>The aliases used for the marker meshes:</h3>
+  <p>
+  <b>board</b><br>
+  <b>truck</b> (x2)<br>
+  <b>wheel</b> (x4)<br>
+  <br>
+  The scale of each part should be 1,1,1, and have no rotation.<br>
+  Origins should be correctly placed at the place where the items are joined to 
+  eachother, refer to the diagram for the placement and size.
+  </p>
+ </body>
+</html>
index 49333651c9a8d1cc19fa00df88f98145acfd48e3..4f1a907c26f8d77ba3c201c06fdeb9240a3a2e32 100644 (file)
@@ -1,18 +1,93 @@
 <!DOCTYPE html>
 <html>
  <head>
+  <style type="text/css">
+   body{
+    margin:40px auto;
+    max-width:650px;
+    line-height:1.6;
+    font-size:18px;
+    color:#444;
+    padding:0 10px
+   }
+   h1,h2,h3{line-height:1.2}
+  </style>
  </head>
 
  <body>
   <h1>Workshop Guide - Custom boards</h1>
-  <p>
-   1. Installing the blender addon
-   2. Open the template board .blend
-   3. Configure the export settings
-   4. Create your art in GIMP
-   5. Compile the model
-   6. Test it out
-   7. Upload to the workshop
+
+  <h2>Installing Blender</h2>
+  <p>You can get the latest version of 
+  <a href="link to blender">blender from steam</a>, this guide is for version
+  3.4 and above.</p>
+
+  <h2>Installing exporter addon</h2>
+  <p>Skaterift comes with the addon in its game files, we just need to install
+  it. This addon script gets updated between skaterift versions.<br>
+  <br>
+  To install, go to [TODO]options > preferences, then to the addons section.<br>
+  [TODO] Add image here<br>
+  [TODO]Now, select install from file, and browse to the skaterift game 
+  files.<br>
+  If you don't know where to find those, you can go into [TODO]steam and 
+  rightclick Skaterift, and browse game files.<br>
+  [TODO] Add image here<br>
+  Now just search for Skate rift in the addons panel, and enable the addon.<br>
+  [TODO] Add image here</p>
+  <hr>
+
+  <h2>Configuring the addon</h2>
+  <p>Open the [TODO] tools tab by pressing N, and click the SkateRift section
+  <br>
+  Next set the output directory to be the game folder<br>
+  [TODO] Add image here</p>
+  <hr>
+
+  <h2>Open the template</h2>
+  <p>Again in the tools folder, you will find a template .blend file for a
+  custom board. Open this to get started<br>
+  [TODO] Add image here<br>
+  An optional step here is to edit the board model, or create one from scratch.
+  <br>If you want to do this, <a href="board_spec.html">take a look at the 
+  detailed board specification</a> for how to set it up. If its your first one,
+  you probably want to skip this step.</p>
+  <hr>
+
+  <h2>Edit the texture</h2>
+  <p>Next step is to customize the artwork, in the template folder there is a
+  texture which you can edit. There is also the original .xcf file which you can
+  open using <a href="Link to gimp">GNU Gimp</a>, or a similar image editor.<br>
+  [TODO] Add image here</br>
+  Now you can change the texture on the material to your own file, and see how
+  it looks in Blender.
+  </p>
+  <hr>
+
+  <h2>Compile the model</h2>
+  <p>Rename the collection name, called boards/[template]/board.mdl, to
+  whatever you would like. The collection name is the path it will export the
+  model, relative to the directory we set earlier.<br>
+  <br>
+  Now in the Skaterift tab in the viewport, we can compile the model.
+  </p>
+  <hr>
+
+  <h2>Test it out in-game</h2>
+  <p>If everything is good, you should be able to visit the board shop and it
+  will be loaded in there.<br>
+  [TODO] add image here
+  </p>
+  <hr>
+  
+  <h2>Upload via the Workshop tool</h2>
+  <p>From the menu of Skaterift, you can open the
+  workshop tool. From here, fill in the folder name which houses the board. This
+  is relative to the game folder just like the export tool. You will know its
+  correct when you see your board after pressing the load button.<br>
+  [TODO] Image of setting the path<br>
+  From here, just fill in the information like the title and description, and
+  press submit.
   </p>
  </body>
 </html>