How to create your own C# Script Template?

Hi guys,

Any idea how do I create my own C# Script Template? So when I go to my context menu Create > C# Script I can select my own type.

So far I've been able to find how to modify existing script templates but not implementing your own.

Any ideas?

Thanks!

 

I'm not aware of any trivially easy way to do it, but it wouldn't be overly hard to create a static class script within an Editor folder and attaching the MenuItem attribute to a static function that executes whatever code you desire when the menu item is selected. You could then either use System.IO.File stuff to copy a file template, or System.IO.FileStream to write out a file either directly from string literals in code or from another file stream reading in and altering the template.

It's still not perfect, because it doesn't automatically select the asset and put it in rename mode, but you can at least do the selection part with the following:

Code (CSharp):

1. Selection.activeObject = asset;
2. EditorApplication.delayCall += () => { EditorUtility.FocusProjectWindow(); };
3.  

You'll need to get the asset object to do so, though, which I believe you can do using AssetDatabase.LoadAssetAtPath(path, type) after you've created it. You'll want to use MonoBehaviour or ScriptableObject for the type, I believe, whichever matches the script type. Can't recall if you also need to call AssetDatabase.Refresh() before you try loading it.

 

http://answers.unity3d.com/questions/120957/change-the-default-script-template.html

 

@AndyGainey Making my own Editor script with a MenuItems attribute is what I am guessing I should be doing, however, I want to be able to name my script without having to manually rename it in IDE.

@LaneFox Thank you, however, I am trying to create my own script template instead of modifying existing ones, so this is not suitable for me.

 

Haven't tried it but this might work.

http://answers.unity3d.com/questions/635684/add-additional-script-templates.html

 

Create a class as an Editor script.

On it have a static method shaped 'static void YourMethod(MenuCommand cmd)'

Attribute it with the 'MenuItemAttribute', naming it "Assets/Create My Custom C# Script".

In said code get the folder based on the active selection (Selection.activeObject), and create a new file based on your own template you have stored somewhere (system System.IO file copy commands, or AssetDatabase.CopyAsset commands... AssetDatabase automatically refreshes the assets).

Something like this:

Code (csharp):

1.  
2. using UnityEditor;
3.  
4. using System.IO;
5.  
6. public class CustomMenuEntries
7. {
8.     public const string PATH_TO_MYSCRIPT_TEMPLATE = @"D:\zTemp\Template.cs";
9.  
10.     [MenuItem("Assets/Create My Custom C# Script")]
11.     public static void CreateCustomScript(MenuCommand cmd)
12.     {
13.         if (Selection.activeObject == null);
14.         var path = AssetDatabase.GetAssetPath(Selection.activeObject);
15.         if (File.Exists(path))
16.             path = Path.GetDirectoryName(path);
17.         if (string.IsNullOrEmpty(path)) path = "Assets/";
18.  
19.  
20.         File.Copy(PATH_TO_MYSCRIPT_TEMPLATE, Path.Combine(path, "NewScript.cs"));
21.         AssetDatabase.Refresh();
22.  
23.     }
24. }
25.  

 

In the end, I wrote a small editor script which creates a file with a .cs extension and manually writes each line of code. Been pain in the neck to get it done correctly, but results are perfect. With this method, I can specify the name of the script, as well some other custom attributes. The whole process is automatic.

In case somebody wants to make their own script, I used this code snippet: http://answers.unity3d.com/questions/12599/editor-script-need-to-create-class-script-automati.html

Thanks for helping me everyone

 

On my Mac the "ScriptTemplates" folder is located inside the "Resources" folder inside the app bundle. Just copy one of the existing ones & give it a new name (and edit it of course). Relaunch Unity and wham, done. I've got all my custom scripts in a folder on my desktop & its the first thing I do after installing a new Unity version. I found the same folder on my PC but honestly I can't remember where it was located.

I have a singleton, scriptableobject & a couple of other templates.
Edit: Added screenshots

 

I found a truly perfect method, hoping to help the next person searching for this problem.

UnityEditor already implements the ability to create and name scripts, so just find out about this function and call it like this:

CreateScriptAsset("Assets/YourTemplatesScript.cs.txt", "DefaultNewScriptName.cs");

Need to add the following code to call it:
Https://gist.github.com/johnsoncodehk/03d3871a1453d795162a6dbf01f904c3

 

This may not be the neatest solution, but maybe it will work well in some cases: in Visual Studio, you can create your own code snippets.

It looks a bit messy (in my humble opinion) with the XML involved, but one nice thing about this method is having the ability to put insert-time replacements in there. You can see this in action if you type

foreach

<tab> <tab> and then tab around the replacements (var, item and collection).

 

@johnsoncodehk Many Thanks! Great elegant find! Thanks so much for posting that.

Small micro-optimization, you only need to do the reflection once to get the method, not every time you call CreateScriptAsset(). i.e:

Code (CSharp):

1.     private static MethodInfo createScriptMethod = typeof(ProjectWindowUtil)
2.         .GetMethod("CreateScriptAsset", BindingFlags.Static | BindingFlags.NonPublic);
3.  
4.     static void CreateScriptAsset(string templatePath, string destName) {
5.       createScriptMethod.Invoke(null, new object[] { templatePath, destName });
6.     }

 

If you want to use CreateScriptAsset() and are making a package for the Unity2018.2 package manager you need to use the packages path. Which can be found by:

1. Including the package in a project
2. Right clicking the template source file
3. Select "Copy Path"
4. Paste the path you just copied to where you need it. It'll be in the format "Packages/com.[company].[project]/Package/Folder/Structure/ScriptTemplate.cs.txt"

 

No longer for Unity 2018.2 at least. The path is now "~\Unity\Editor\Data\Resources\ScriptTemplates". If you want to modify the look of the new c sharp scripts on creation, edit "81-C# Script-NewBehaviourScript.cs.txt" to your liking.

Before:

​

After:

​

 

this works well, except the name of the class in the new script follows what's in the template. tips on how to make it follow the name you give the new file? cheers!

 

Sorry if I understand the wrong question.
You can replace the class name with #SCRIPTNAME#, for example:
https://github.com/Unity-Technologi...Tile/ScriptTemplates/NewCustomRuleTile.cs.txt

 

perfect, cheers!

 

hello, i'm trying to create iruntime.. how i should be able to create my script by template then add it to an object?

 

There's an easier version than using Reflection. Just use

UnityEditor.ProjectWindowUtil.CreateScriptAssetFromTemplateFile(string pathToTemplateTxtFile, string defaultNewScriptName)

instead.

Example:

C# editor-script for making a new right click command and create the new script file:

Code (CSharp):

1. //ATTENTION: Put this script file into an "Editor"-folder for it to work properly.
2.  
3. using UnityEditor;
4.  
5. public class CreateNewScriptClassFromCustomTemplate
6. {
7.     private const string pathToYourScriptTemplate = "Assets/YourScriptTemplatesFolder/YourTemplateScript.cs.txt";
8.  
9.     [MenuItem(itemName: "Assets/Create/Create New Script from Custom Template", isValidateFunction: false, priority: 51)]
10.     public static void CreateScriptFromTemplate()
11.     {
12.         ProjectWindowUtil.CreateScriptAssetFromTemplateFile(pathToYourScriptTemplate, "YourDefaultNewScriptName.cs");
13.     }
14. }

-----

And "YourTemplateScript.cs.txt" should look something like this:

Code (CSharp):

1. using System.Collections;
2. using System.Collections.Generic;
3. using UnityEngine;
4.  
5. namespace YourNamespace
6. {
7.     public class #SCRIPTNAME# : MonoBehaviour
8.     {
9.         //TestyTest  
10.     }
11. }

Here's an example of how the project structure could look like:

 

@Paalo Looks like ProjectWindowUtil.CreateScriptAssetFromTemplateFile does not exist in Unity 2018.3 what version was that method introduced in?

 

Looks like it got introduced in 2019.1

 

I used this information update the gist, thank you!

 

I love Paalo's solution.

For those of us with multiple editors installed (anyone making asset store assets, for instance), I also recommend using symlinks, which seamlessly forces Unity to share the templates across all versions of Unity installed.

(I cannot think of a single situation where I'd need different copies of Unity to have their own unique project templates, so I think Unity's decision to bundle them inside the Editor's binary/install folder was less than ideal).

For windows: You need a HARD symlink (as Windows isn't as good an OS when it comes to understanding symlinks, you need to be more brutal). First move the ScriptTemplates folder somewhere on your hard disk, then delete it from all current Editors, and instead use "mklink /J [location of shared folder] [location of Unity editor's template folder]" once for each Editor.

e.g.

Code (CSharp):

1. mklink /J Unity-2019.3.3\Editor\Data\Resources\ScriptTemplates D:\development\Unity-shared-ScriptTemplates

Similarly with OSX, but instead of mklink, you're fine to use a SOFT symlink (OSX has a more standard Unix-like implementation of symlinks, and apps should all be happy to use the softlinked folder) - use "ln -s [location of shared folder] [location of unity editor tempaltes folder]"

 

Another approach can be:
https://medium.com/@tuznev/how-create-custom-script-template-in-unity-ab2cbb6172b5

 

Paalo suggestion is really useful.

 

I made a github repo for it with some of my own templates.
Can be found on : https://github.com/guraysenova/Create-Classes

 

I found this way very useful : https://weirdbearddev.com/2020/08/01/creating-custom-unity-script-templates/

 

This is the proper solution. Thanks for posting this.

 

Hmm, very interesting that they have secret magic naming we can make use of. That's perfect but I never would have found it; doesn't seem to be in the docs hidden in any corner, just off on a Unity Support post

Props to Paalo nonetheless, his was simple enough for my case so it would have been very helpful