{"id":19773570,"url":"https://github.com/stereokit/stereokit.templates","last_synced_at":"2025-04-30T18:31:55.716Z","repository":{"id":63327493,"uuid":"567059938","full_name":"StereoKit/StereoKit.Templates","owner":"StereoKit","description":"Dotnet new templates for StereoKit projects","archived":false,"fork":false,"pushed_at":"2025-02-21T21:46:34.000Z","size":148,"stargazers_count":7,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-04T22:05:58.182Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/StereoKit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-11-17T01:27:08.000Z","updated_at":"2025-02-21T21:46:38.000Z","dependencies_parsed_at":"2024-03-09T00:44:06.269Z","dependency_job_id":null,"html_url":"https://github.com/StereoKit/StereoKit.Templates","commit_stats":{"total_commits":15,"total_committers":2,"mean_commits":7.5,"dds":0.1333333333333333,"last_synced_commit":"e100ebe05e4d6dfbb615a1dd40c4709e964e54aa"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StereoKit%2FStereoKit.Templates","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StereoKit%2FStereoKit.Templates/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StereoKit%2FStereoKit.Templates/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StereoKit%2FStereoKit.Templates/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StereoKit","download_url":"https://codeload.github.com/StereoKit/StereoKit.Templates/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251761001,"owners_count":21639529,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T05:10:07.796Z","updated_at":"2025-04-30T18:31:55.701Z","avatar_url":"https://github.com/StereoKit.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# StereoKit.Templates\n\nThese [StereoKit](https://stereokit.net) templates are designed to be used with the `dotnet new` command for command-line and environments like Visual Studio Code, and also work with Visual Studio 2022's \"New Project\" interface! You do not need to clone this repository, these templates can be installed easily via the NuGet package.\n\n## Install\n\n```bash\n# Install the templates!\ndotnet new install StereoKit.Templates\n```\n\n### Pre-requisites\n\nIf you don't have the .NET SDK, or the `dotnet` command, you can install this via winget:\n\n```bash\nwinget install Microsoft.DotNet.SDK.9\n# Restart the Terminal to refresh your Path variable\n```\n\nOn Linux, it may be as simple as this! If not, check [Microsoft's instructions](https://learn.microsoft.com/en-us/dotnet/core/install/linux) for installing `dotnet` on your Linux distribution.\n\n```bash\nsudo apt-get install dotnet-sdk-9.0\n```\n\n## Usage\n\nThe `sk-net` template is a good place to start. It works with VR on Windows and Linux, and provides a good Simulator for development.\n\n```bash\n# Create a .NET Core based StereoKit project, and run it\nmkdir SKProjectName\ncd SKProjectName\ndotnet new sk-net\ndotnet run\n```\n\n### Android Projects\n\nThe `sk-multi` template can also deploy to Android devices. While this experience is mostly seamless when using Visual Studio 2022, using CLI or VS Code is not as simple as `dotnet run`. Instead, you must build an apk and install that:\n\n```bash\n# Start with an multiplatform project\ndotnet new sk-multi\n# You _can_ still run the StereoKit Simulator like this\ndotnet run\n# To run on Android, just run the Android flavored project!\ndotnet run --project Projects\\Android\\SKProjectName.Android.csproj\n```\n\n#### Publishing an APK\n\nYou can also build and deploy an APK like this! This was the only way to do it in the past, but may still be useful in some scenarios.\n\n```bash\n# The build command for making the Android APK\ndotnet publish -c Release Projects\\Android\\SKProjectName.Android.csproj\n\n# Install on device\nadb install Projects\\Android\\bin\\Release\\net9.0-android\\publish\\com.companyname.skprojectname-Signed.apk\n# Run the APK on device\nadb shell monkey -p com.companyname.skprojectname 1\n```\n\nAdditional information about signing apks while building like this [can be found here](https://learn.microsoft.com/en-us/dotnet/maui/android/deployment/publish-cli).\n\n### Items\n\n```bash\n# Add an unlit shader named \"test_shader\" to the Assets folder\ndotnet new skshader-unlit -n test_shader -o Assets\n\n# Add an shader with default lighting named \"test_lit_shader\" to the Assets\n# folder\ndotnet new skshader-lit -n test_lit_shader -o Assets\n\n# Add a basic IStepper template called SomeSystem\ndotnet new skstepper -n SomeSystem.cs\n```\n\n## Templates\n\n### Project templates:\n\n|Id       |Project    | Description                                        |\n|---------|-----------|----------------------------------------------------|\n|sk-net   |.NET Core  |Simpler project for Windows and Linux desktop XR.   |\n|sk-multi |Multitarget|Cross-platform project for Android/Windows/Linux XR.|\n|sk-sketch|.NET Core  |Bare-bones XR template for small code sketches.     |\n\n### Item templates:\n\n|Id            |Type  | Description                                           |\n|--------------|------|-------------------------------------------------------|\n|skstepper     |C#    |A simple empty class that implements IStepper.         |\n|skshader-lit  |Shader|A basic shader that uses StereoKit's built-in lighting.|\n|skshader-unlit|Shader|A simple shader without any lighting.                  |","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstereokit%2Fstereokit.templates","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstereokit%2Fstereokit.templates","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstereokit%2Fstereokit.templates/lists"}