S&box Wiki

Revision Difference


<cat>Dev.Intro</cat> <title>Tools</title> A quick overview of the tools you can use within `sbox-dev.exe` You can find `sbox-dev.exe` in the installation directory for s&box. Here is a quick video for those who are still struggling. <upload src="70317/8d96f75d0cffb9f.mp4" size="13161842" name="s&amp;box_tools.mp4" /> Basic Tools will be explained here if they do not have a dedicated page or category for them, if someone creates one that's good, I will link to it here. More Advanced tools like modeldoc, material editor, particle editor and hammer, I will link to some basic pages to start from, but please look through the categories on the left of the s&box Wiki to get a better look into some more advanced tools. <warning>This is currently still in the works, some of the tools mentioned below I don't have a good understanding of yet or do not work. Some might be removed later on from the game or changed, or people will add more information about them later on (such as the animgraph which might need its own category for)</warning> [Asset Browser](https://wiki.facepunch.com/sbox/Dev_Tools#assetbrowser) [Hammer](https://wiki.facepunch.com/sbox/Dev_Tools#hammer) [Material Editor](https://wiki.facepunch.com/sbox/Dev_Tools#materialeditor) [ModelDoc](https://wiki.facepunch.com/sbox/Dev_Tools#modeldoc) [Animgraph](https://wiki.facepunch.com/sbox/Animgraph_breakdown) [Particle Editor](https://wiki.facepunch.com/sbox/Dev_Tools#particleeditor) [VData Editor] - **To be Documented** [Text Editor](https://wiki.facepunch.com/sbox/Dev_Tools#texteditor) [Image Subrect Editor](https://wiki.facepunch.com/sbox/Dev_Tools#imagesubrecteditor) [Postprocessing Editor](https://wiki.facepunch.com/sbox/Dev_Tools#postprocessingeditor) [StyleEditorTool](https://wiki.facepunch.com/sbox/Dev_Tools#styleeditortool) [Source Filmmaker 2] - **To be Documented** [VMix Sound Mix Editor](https://wiki.facepunch.com/sbox/Dev_Tools#vmixsoundmixeditor) [Face Poser] - **To be Documented?** [Voice Over Helper] - **To be Documented** [Inspector](https://wiki.facepunch.com/sbox/Inspector_-_Decals_SurfaceProperties_&_Sound) ⤶ [External Console](https://wiki.facepunch.com/sbox/Dev_Tools#externalconsole)⤶ # Asset Browser Once you get into and load up `sbox-dev` you will get the base game, and this window. ![Asset Browser](https://i.imgur.com/MO0oCOg.png) This is your new best friend, when dealing with making content this is going to be your everything for getting it into the game and ready to use. <note>Try and avoid closing this till you are finished messing with what you need, since this acts as the hub or homepage to all the tools you will be using and where you will access and see all your content from. Don't worry though, if you ever do accidentally close it but still have on of the other tools open, you can still get to it on any of the tools, at the top right just click this little button: ![Tools](https://i.imgur.com/fTC5oqW.png) and then chose the first option, asset browser: ![tools asset browser](https://i.imgur.com/mzoDFee.png) </note> Lets break this up so you can understand more. ## Tools First things first you will notice all these icons at the top, these are all your tools you can and or will use. Such as: Hammer for maps, Material editor for materials, ModelDoc for models and so on, you get the gist. ![tools list](https://i.imgur.com/Pz41STL.png) We will go into all of them one by one later on though. ## Main Asset Browser This is where you will be looking up, finding your content and assets, searching, searching searching over and over. without having to go through the files manually, it is really useful to get a view of all the content in your game, and in your gamemodes and so on. ![asset browser](https://i.imgur.com/RDzarpg.png) Lets go through everything here, these are the main things other than the main window. 1. All Assets - this will most likely the main tab you view from, it filters based on ALL the content in your game files 2. Most Recently Used Assets - this gives you a view of your most recently created, changed and such assets, meaning if you just want to see only the things you added recently you can use this tab. 3. Search Bar - this is just as it says, allows you to search what you need, like "sand" for your sand materials and such. 4. Mods Filter - this allows you to hide or show content from certain mods, (also allowing you to show only 1 mod or all mods and so on in 1 button press) really useful if you have a lot of content in your files, but only need to focus on the content in one mod. 5. Asset Types Filter - this allows you to filter for specific folder types, like only materials, only models, only sounds, only raw images (png, jpg and so on) which is really useful if you only need to mess with materials but don't need to see any other folder types in there. 6. Preview Window - when you select an asset in the browser this window will show a view of the asset you selected, (i will explain more below) Also things such as Hammer has a small version of the asset browser built into it. ## Preview Window Here is a proper look into the preview window. ![preview window](https://i.imgur.com/hcUhivG.png) In here it will display models, textures, materials, particles in a 3d way (materials being displayed on a ball), sounds will also play once when you click them in the asset browser. Viewing a model gives you the most options in here. Here is everything it shows .Preview State - allows you to switch or turn off and on body groups on the model .MatGrp - allows you to change the material on the model between material groups .Sequence - this allows you to preview animations put onto the model In the Skeleton section it just enables rending on invisible things, such as the skeleton, the joins, hitboxes and so on. You can also switch between hitbox groups, such as arms, legs, torso and such. Then it will show the basic folder path of the asset. then below show the actual folder path of the game file (compiled file that cant be edited, meant for just game use), and content file (this file is where you can edit and change the basic materials, models and such, the decompiled version of it for game DEV use) Then below is your references, this just gives you a view of where the asset is reference and what it referencing. Such as Uses - animgraph. then material 1 material 2 material 3... which are used by vtex 1 vtex 2 vtex 3... and so on. Used by - vmap 1 and such. # Hammer Hammer for people who are not sure what it is, is the tool where people make maps, you can also with this new version in theory make your own really basic models within hammer as well, but ideally you will do that externally and leave hammer to all the mapping work. This is a good guide to go from for the basics. https://wiki.facepunch.com/sbox/Creating_your_first_gm_flatgrass But I also recommend having a look through this. https://wiki.facepunch.com/sbox/Mapping_Resources Mainly the Eagle One Source 2 Hammer Crash Course, since it will go over most of what you need, but if you are starting from fresh, try go through as much of them and then get into experimenting in hammer before you rush head first into the map you wanna make. # Material Editor The material editor is where you will be setting up your materials for your models, or mapping materials and so on. Its what you throw you basic image textures into like you color, normal and so on and specify the shader to do what you need. This is a good place to start: https://wiki.facepunch.com/sbox/guide_to_making_materials # Modeldoc Modeldoc is where you will be importing your base meshes, then applying your materials onto the mesh, adding LODs, animations, material groups, bodygroups and all these things. It's just where you will be setting up everything you need for your physical model in-game. a good place to start from for this is https://wiki.facepunch.com/sbox/Importing_a_new_model and also https://wiki.facepunch.com/sbox/Importing_Rust_Weapon_Models # Animgraph # Particle Editor The particle editor is where you will create you fun explosions, blood splats, water splashes and so on. a good place to start would be here https://wiki.facepunch.com/sbox/Creating_your_first_particle_effect if you do want to understand more of the options you have and can do have a look through here https://wiki.facepunch.com/sbox/Understanding_Emmiters_Initializers_&_Operators # VData Editor # Text Editor This is literally a built in text editor, like notepad. I think it's there to edit code? But I would recommend using Visual Studio Code over this. ![text editor](https://i.imgur.com/NfVBwKs.png) It works... but there isn't much to it. #Image Subrect Editor This Tool is what you use when you are making HotSpot materials that are to be used in hammer. ![subrect editor](https://i.imgur.com/5mnDypR.png) I do recommend to look through here on how it works. https://developer.valvesoftware.com/wiki/Half-Life:_Alyx_Workshop_Tools/Level_Design/Hotspot_Texturing one extra thing. You can use the rectangle properties at the top left to adjust the exact size and position. but ideally you would keep it as is and maker the rectangles around the given grid, if you are to mess with the size of the rectangles you will want to keep the size it takes up to a power of 2, so 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048 and so on, just like you would do with a texture in a material. one you have finished drawing all the rectangles for the hotspot material, you can save it as a .rect file and then apply it onto your material within here. ![rect file](https://i.imgur.com/vUD3DfW.png) this will allow you to use it as a hotspot material in hammer. # Postprocessing Editor https://developer.valvesoftware.com/wiki/Half-Life:_Alyx_Workshop_Tools/Postprocessing_Editor Please look through here since this goes over how it work, as it works the same as alyx. # StyleEditorTool This just allows you to change the general theme of all your tools including the asset browser. ![style editor](https://i.imgur.com/cI34uKp.png) you can save your style or load other peoples styles. there is also the randomize... which i do not recommend clicking ![randomized](https://i.imgur.com/HdJ4mqx.png) don't worry though you can reset back to default with the reset button just a nice way to change how it all looks if you really hate how it looks by default. # Source Filmmaker 2 # VMix Sound Mix Editor A tool used to add effects to and change properties of sounds, useful for dynamic audio and music. Kind of like Animgraph, but for sound. Will add more details once it's able to be controlled in-game. ![vmix sound mix editor](https://i.imgur.com/6Ttv5X0.png) # Face Poser # Voice Over Helper ⤶ # External Console⤶ ⤶ This is basically the console in base sandbox, but well... external because why not.⤶ ⤶ Within it you can see a few interesting and useful things on the left.⤶ such as Entities which shows all the current entities within the current game, and some panel, library and hotload lists.⤶ ⤶ On your middle you see the main console, you can put your commands in here, but also it shows everything going on, so messages, from client, server, and so on.⤶ ⤶ You can click these to show more info on the right, such as, what is this? info, warning or something else. and also if it is an issue related to a file a stack trace, where it can show what issues have happened in what files, which can be useful if you messed something up in your code.⤶ ⤶ Also if anything was to happen and your game crashed, most of the time your external console wont go down with it, meaning hopefully it can show what issue had happened.⤶ ⤶ ![console](https://i.imgur.com/2ipLIZB.png)⤶ ⤶ <note>⤶ If it's not opening, then you might need to download [webview2](https://developer.microsoft.com/en-us/microsoft-edge/webview2/). If it still isn't working you might also need to install [ASP.NET Core](https://dotnet.microsoft.com/download/dotnet/thank-you/runtime-aspnetcore-3.1.14-windows-x64-installer).⤶ </note>