Modding - Revision history

Pikoyio at 05:01, 12 July 2019

2019-07-12T05:01:57Z

Pikoyio at 05:00, 12 July 2019

2019-07-12T05:00:48Z

Maguschala: /* Asset Manager */

2018-10-22T23:27:19Z

‎Asset Manager

TheMogMiner: Updated steps to reflect the new menu-naming scheme.

2018-01-28T15:18:59Z

Updated steps to reflect the new menu-naming scheme.

DeamonHunter: Fix a couple formatting errors.

2017-11-27T06:49:16Z

Fix a couple formatting errors.

DeamonHunter: Added a substantial setup and explanation tutorial. Should be better than the previous setup tutorial.

2017-11-27T06:48:18Z

Added a substantial setup and explanation tutorial. Should be better than the previous setup tutorial.

Show changes

DeamonHunter: Removing palettes from Modding as it's getting it's own page.

2017-05-31T09:27:55Z

Removing palettes from Modding as it's getting it's own page.

DeamonHunter: Clarify the heading more

2017-04-08T05:25:12Z

Clarify the heading more

DeamonHunter: Removed Accesory Tutorials to move them to their own page.

2017-03-14T10:24:51Z

Removed Accesory Tutorials to move them to their own page.

Show changes

DeamonHunter: Removing Tile tutorials in preperation to move the to Tile

2017-02-19T05:45:17Z

Removing Tile tutorials in preperation to move the to Tile

Show changes

@@ Line 130: / Line 130: @@
 === Using the AssetManager to Create Mods ===
 The Asset Manager is an all-in-one Modding Program for Staxel. It allows you to create and edit new files.
 '''While Asset Manager is good for creating files and checking them, it is recommended to make / edit mods in a Text Editor. Asset Manager is known to not save some properties.'''

@@ Line 130: / Line 130: @@
 === Using the AssetManager to Create Mods ===
 The Asset Manager is an all-in-one Modding Program for Staxel. It allows you to create and edit new files.
 To get to the Assetmanager do the following;

@@ Line 255: / Line 255: @@
 From there you may begin using tools (under '''"Tools"''' in the top menu) or editing assets. To edit assets, open the window for the type of asset you wish to edit (under '''"View"''' in the top menu, or press '''CTRL+Shift+1-9''') and have at it.
-The Live Content System ('''"View->Content System Live"''') shows you exactly what is in Staxel's content directory, and let's you manage (create/delete) files and folders within the content directory safely.
+The Live Content System ('''"View->Content System Live"''') shows you exactly what is in Staxel's content directory, and lets you manage (create/delete) files and folders within the content directory safely.
 The Asset Manager also comes with a Mod Manager ('''"View->Mod Manager"'''). The Mod Manager allows you to create mod packages ('''*.sxlmod''' files) and (un)install them, and delete them, whenever you please. Creating a mod package (in the Mod Manager click '''"Mod->New->Create New Package..."''') is as simple as selecting files to include in the mod and choosing a name for the mod. Once that is done the mod package is ready to be shared or installed at your convenience. To install or uninstall mods select the mod packages from the list and either click '''"Mod->Install Packages/Uninstall Mods"''' or right-click the selected packages and click '''"Install Packages/Uninstall Mods"''' from the menu. Files from an installed mod that have been edited (by yourself, hopefully) will not be uninstalled, but may be overwritten by reinstalling the associated mod package (assuming the file comes from the associated mod package). Installed mods must be built (if not already, and/or validated) by clicking the '''"File->All Assets->Build and Validate Assets"''' button in the Asset Manager. This can be done for you  automatically, or turned off, by changing the appropriate setting ('''"Automatically Build Mods After Installation"''') in your preferences.
@@ Line 266: / Line 266: @@
 ''[More comprehensive help section coming...]''
 == ContentBuilder ==

@@ Line 220: / Line 220: @@
 To create a '''<tt>*.sxlmod</tt>''' you will need to follow this procedure;
 # Head to <code>C:\Users\[Your username here]\%localappdata%\Staxel.Launcher\gamedata\bin\</code> and start '''<code>Staxel.ModManager.exe</code>'''
-# Head to '''<tt>Mod → New → Create new Package</tt>'''. Once you have done that follow the instruction set that fit your situation;
+# Head to '''<tt>Sxl Mods → New → Create new Package</tt>'''. Once you have done that follow the instruction set that fit your situation;
 # Fill in all the details you want.
 # After that is done, drag your mod files, that are underneath the main mod folder (For Example, if your mod is say <tt>"WoodStuff"</tt> drag all the stuff inside the <tt>"WoodStuff"</tt> folder), into the shaded "Drag and Drop" area, to move them into the mod's folder.

@@ Line 91: / Line 91: @@
 * Accessories can be made with a single layer. Save the current model (i.e. create a .vox file) under the exact same name as the layer, then export the model. This model will be saved under that layer name.
 * It is possible to create a Layered object with only using models with no layers. See [[#Layered Voxels]] to see how this can happen.
 ==== VoxelShop ====
@@ Line 108: / Line 109: @@
 * Large files can take a long time to load. (Compared to Qubicle.)
 * Options and features are a little more obtuse than counterparts. But it is simple to get the hang of once used.
 === Getting Started with Modding ===
@@ Line 124: / Line 126: @@
 The following two sections will detail how to use each part. Feel free to skip to [[#Finding out how to Create a Specific Thing]], if you just want to get on to modding.
 === Using the AssetManager to Create Mods ===

← Older revision		Revision as of 09:27, 31 May 2017
Line 93:		Line 93:
	After picking and choosing programs, the final step should be to set up a folder in which you can put your work in. This folder should be easy to get to, such as on the desktop, but if you want to back it up in Dropbox/Google Drive than feel free to do so. This means that you will always have a backup folder to rely on rather than working inside the game's files. After creating this folder, navigate to the games <code>\mods\</code> folder and right click on it. Select '''<tt>Create Shortcut</tt>''' and drag this shortcut to the folder you created before. This will save a lot of time trying to search for this folder, and will help with moving files around.		After picking and choosing programs, the final step should be to set up a folder in which you can put your work in. This folder should be easy to get to, such as on the desktop, but if you want to back it up in Dropbox/Google Drive than feel free to do so. This means that you will always have a backup folder to rely on rather than working inside the game's files. After creating this folder, navigate to the games <code>\mods\</code> folder and right click on it. Select '''<tt>Create Shortcut</tt>''' and drag this shortcut to the folder you created before. This will save a lot of time trying to search for this folder, and will help with moving files around.

−
−	~~== Creating a Palette for Player Models ==~~
−	A palette is basically an optional colour scheme for a given accessory model. Models do not necessarily need to support palettes (you can have a completely unpalettable model designed to only have one colour scheme), but models which are designed to support palettes can essentially have any number of colour schemes limited only by the number of palettes defined.
−
−
−	'''In essence, a palette is an image with two rows of different colours. The top row of colours are the colours you want to replace, and the bottom row are the colours you want to replace the colour above with.'''
−
−
−	~~To create a palette you must first have a model to base the palette off. Without a model, a palette is basically useless. Once you have acquired a model to work with;~~
−	#You will first need to create an image in your favourite image software. (Photoshop, Gimp, even Paint is fine for this.) The size of the image will be 16 pixels per colour you want to change in the width(For Example if you want to change '''<tt>4 colours</tt>''', you will need to make your image '''<tt>64 pixels</tt>''' wide) while being exactly '''<tt>32 pixels</tt>''' high.
−	#Start by setting the top left most '''<tt>16x16</tt>''' grid to the first colour that you want to change. Once that '''<tt>16x16</tt>''' is filled, fill the '''<tt>16x16</tt>''' to the right of it with the second colour. Keep doing this until all colours are filled. This gives the basis on which your Palette is set.
−	~~#When that is done, you can now choose which colours you want to replace the originals with, and fill the space underneath that colour. Continue until you are done.~~
−	~~#Save it as a '''<tt>"*.png"</tt>''' file. You can now move that to a mod folder but we aren't done yet.~~
−
−	~~[http://puu.sh/qnbAL/bb7b8b9e3b.png Example of a palette that replaces 4 colours.]~~
−
−
−	~~With that, you have now created the image that is required for a palette. You will then need to create an icon for your palette. This icon gets displayed in the menu representing the palette.~~
−	~~#Go back to the image editor, and create another image, this time exactly '''<tt>12x12</tt>''' in size.~~
−	~~#Fill this with anything you like, such as having a <tt>"S"</tt> for <tt>"Suzy's Hair Colour"</tt>. A recommendation would be to have a solid colour representing the main colour of your hairstyle.~~
−	~~#Save this image as a '''<tt>*.png</tt>''' file. (If you want, name this as the same as the file containing the palette but append <tt>" icon"</tt> to it.)~~
−
−	~~[http://puu.sh/qnbPO/2d1958e355.png Example of a non-standard Icon to represent a palette.]~~
−
−
−	~~With those two images made, we are now ready to actually tell the game "Hey this is a palette!" So we need to create a '''<tt>*.palette</tt>''' file with the following inside of it;~~
−	~~<pre>{~~
−	~~"code" : "mods.modname.uniquenamehere",~~
−	~~"icon" : "mods/Modname/NameOfIcon.png",~~
−	~~"palette" : "mods/Modname/NameOfPalette.png"~~
−	~~}</pre>~~
−
−	~~The <tt>"code"</tt> property is just a unique name for the palette. Set this to be the same as the directory and file name starting at <code>/mods/</code> replacing any <tt>"/"</tt> with <tt>"."</tt>.~~
−
−	~~The <tt>"icon"</tt> property is the path to the small '''<tt>12x12</tt>''' image you created earlier.~~
−
−	~~The <tt>"palette"</tt> property is the path to the palette that you created earlier.~~
−
−
−	~~With this the palette is now ready to be added to models. You may now add/edit the following line in any '''<tt>*.accessory</tt>''' file to include the code name from your palette.~~
−	~~<pre>"palettes" : [ "mods.modname.palette1", "mods.modname.palette2"] </pre>~~
−
−	~~And if everything went according to plan, you can now select your custom palette from your model.~~

	== Hooks ==		== Hooks ==

@@ Line 1: / Line 1: @@
 [[Category:Modding]]
 This page is meant to give an overview into Staxel's modding systems and give you insight into how to install, modify and create your own mods in the game.
 '''Please note this page, and the game itself, is a Work In Progress. Many things are likely to change with the modding systems and any of these methods can be made obsolete at any time.'''
-If you are looking for config options, head on over to [[Modding Configs]] for more in depth information.
+'''Head to [[:Category:Modding]] to look for a specific item to Mod. Most items includes tutorials on how to implement those items within their pages.'''
 Most Recent change: 07/02/17 [[#Changelog]]