Merge pull request #2 from kurone-kito/implement-the-package-project

.github/CODE_OF_CONDUCT.ja.md

@@ -49,7 +49,7 @@ Language: [🇬🇧](./CODE_OF_CONDUCT.md) | **🇯🇵** | [🇨🇳](./CODE_OF
 
 ## 執行
 
-虐待的、嫌がらせ、またはその他の許容できない行動の事例は、執行を担当するコミュニティリーダーに対して [Issues](https://github.com/kurone-kito/vpm-project-template/issues) で報告される場合があります。
+虐待的、嫌がらせ、またはその他の許容できない行動の事例は、執行を担当するコミュニティリーダーに対して [Issues](https://github.com/kurone-kito/udonsharp-toybox/issues) で報告される場合があります。
 すべての苦情は迅速かつ公正にレビューおよび調査されます。
 
 すべてのコミュニティリーダーは、問題の報告者のプライバシーとセキュリティを尊重する義務があります。

.github/CODE_OF_CONDUCT.md

@@ -62,7 +62,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[Issues](https://github.com/kurone-kito/vpm-project-template/issues).
+[Issues](https://github.com/kurone-kito/udonsharp-toybox/issues).
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

.github/CODE_OF_CONDUCT.zh.md

@@ -40,7 +40,7 @@ Language: [🇬🇧](./CODE_OF_CONDUCT.md) | [🇯🇵](./CODE_OF_CONDUCT.ja.md)
 
 ## 监督
 
-辱骂、骚扰或其他不可接受的行为可通过 [Issues](https://github.com/kurone-kito/vpm-project-template/issues) 向负责监督的社区领袖报告。
+辱骂、骚扰或其他不可接受的行为可通过 [Issues](https://github.com/kurone-kito/udonsharp-toybox/issues) 向负责监督的社区领袖报告。
 所有投诉都将得到及时和公平的审查和调查。
 
 所有社区领袖都有义务尊重任何事件报告者的隐私和安全。

.github/CONTRIBUTING.ja.md

@@ -5,14 +5,14 @@ Language: [🇬🇧](./CONTRIBUTING.md) | **🇯🇵** | [🇨🇳](./CONTRIBUTI
 ---
 
 このリポジトリに貢献する際には、変更を加える前に、このリポジトリの所有者と
-[Issues](https://github.com/kurone-kito/vpm-project-template/issues)
+[Issues](https://github.com/kurone-kito/udonsharp-toybox/issues)
 やその他の方法で変更したいことについて最初に話し合ってください。
 
 [行動規範](./CODE_OF_CONDUCT.ja.md)がありますので、
 プロジェクトとのやり取りのすべてに従ってください。
 
 もしあなたのアイデアが小さな修正で示せるのなら、
-[Pull request](https://github.com/kurone-kito/vpm-project-template/pulls)
+[Pull request](https://github.com/kurone-kito/udonsharp-toybox/pulls)
 を直接活用してください。
 
 このリポジトリでは、[英語、または日本語](https://translate.google.com/)

.github/CONTRIBUTING.md

@@ -4,10 +4,10 @@ Language: **🇬🇧** | [🇯🇵](./CONTRIBUTING.ja.md) | [🇨🇳](./CONTRIB
 
 ---
 
-When contributing to this repository, please first discuss the change you wish to make via [Issues](https://github.com/kurone-kito/vpm-project-template/issues) or any other method with the owners of this repository before making a change.
+When contributing to this repository, please first discuss the change you wish to make via [Issues](https://github.com/kurone-kito/udonsharp-toybox/issues) or any other method with the owners of this repository before making a change.
 
 Please note we have a [code of conduct](./CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
 
-If your idea can be shown with a minor fix, please use directly the [pull request](https://github.com/kurone-kito/vpm-project-template/pulls).
+If your idea can be shown with a minor fix, please use directly the [pull request](https://github.com/kurone-kito/udonsharp-toybox/pulls).
 
 In this repository, discussion [in English or Japanese](https://translate.google.com/) is recommended.

.github/CONTRIBUTING.zh.md

@@ -8,6 +8,6 @@ Language: [🇬🇧](./CONTRIBUTING.md) | [🇯🇵](./CONTRIBUTING.ja.md) | **
 
 请注意我们有[行为准则](./CODE_OF_CONDUCT.ja.md)，请在与项目的所有互动中遵循。
 
-如果您的想法可以通过小修复显示，请直接使用[拉取请求](https://github.com/kurone-kito/vpm-project-template/pulls)。
+如果您的想法可以通过小修复显示，请直接使用[拉取请求](https://github.com/kurone-kito/udonsharp-toybox/pulls)。
 
 在此存储库中，建议使用[英语或日语](https://translate.google.com/)进行讨论。

.github/issue_template.md

@@ -1,10 +1,10 @@
 <!--
 🇺🇸🇬🇧 At first, read the following documents:
-https://github.com/kurone-kito/vpm-project-template/blob/main/.github/CONTRIBUTING.md
+https://github.com/kurone-kito/udonsharp-toybox/blob/main/.github/CONTRIBUTING.md
 
 🇯🇵 投稿の前に下記のドキュメントを一読ください:
-https://github.com/kurone-kito/vpm-project-template/blob/main/.github/CONTRIBUTING.ja.md
+https://github.com/kurone-kito/udonsharp-toybox/blob/main/.github/CONTRIBUTING.ja.md
 
 🇨🇳 首先，阅读以下文档:
-https://github.com/kurone-kito/vpm-project-template/blob/main/.github/CONTRIBUTING.zh.md
+https://github.com/kurone-kito/udonsharp-toybox/blob/main/.github/CONTRIBUTING.zh.md
 -->

.github/pull_request_template.md

@@ -1,10 +1,10 @@
 <!--
 🇺🇸🇬🇧 At first, read the following documents:
-https://github.com/kurone-kito/vpm-project-template/blob/main/.github/CONTRIBUTING.md
+https://github.com/kurone-kito/udonsharp-toybox/blob/main/.github/CONTRIBUTING.md
 
 🇯🇵 投稿の前に下記のドキュメントを一読ください:
-https://github.com/kurone-kito/vpm-project-template/blob/main/.github/CONTRIBUTING.ja.md
+https://github.com/kurone-kito/udonsharp-toybox/blob/main/.github/CONTRIBUTING.ja.md
 
 🇨🇳 首先，阅读以下文档:
-https://github.com/kurone-kito/vpm-project-template/blob/main/.github/CONTRIBUTING.zh.md
+https://github.com/kurone-kito/udonsharp-toybox/blob/main/.github/CONTRIBUTING.zh.md
 -->

.github/workflows/build-listing.yml

@@ -54,6 +54,16 @@ jobs:
             ${{ env.pathToCi }}/.nuke/temp
             ~/.nuget/packages
           key: ${{ runner.os }}-${{ hashFiles('**/global.json', '**/*.csproj') }}
+      - name: Correct the documentation metadata
+        uses: nikeee/docfx-action@v1.0.0
+        with:
+          args: metadata Documentation/docfx.json
+      - name: Build the documentation
+        uses: nikeee/docfx-action@v1.0.0
+        with:
+          args: build Documentation/docfx.json
+      - name: move the documentation to the publish directory
+        run: cp -r Documentation/_site ${{ env.listPublishDirectory }}/docs
       - name: Build Package Version Listing with Nuke
         run: ${{ env.pathToCi }}/build.cmd BuildRepoListing --root ${{ env.pathToCi }} --list-publish-directory $GITHUB_WORKSPACE/${{ env.listPublishDirectory }} --current-package-name ${{ vars.PACKAGE_NAME }}
         env:

.gitignore

@@ -1,5 +1,14 @@
-# Created by https://www.toptal.com/developers/gitignore/api/linux,macos,unity,vim,visualstudiocode,windows
-# Edit at https://www.toptal.com/developers/gitignore?templates=linux,macos,unity,vim,visualstudiocode,windows
+# Created by https://www.toptal.com/developers/gitignore/api/dotnetcore,linux,macos,unity,vim,visualstudiocode,windows
+# Edit at https://www.toptal.com/developers/gitignore?templates=dotnetcore,linux,macos,unity,vim,visualstudiocode,windows
+
+### DotnetCore ###
+# .NET Core build folders
+bin/
+obj/
+
+# Common node modules locations
+/node_modules
+/wwwroot/node_modules
 
 ### Linux ###
 *~
@@ -187,10 +196,18 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-# End of https://www.toptal.com/developers/gitignore/api/linux,macos,unity,vim,visualstudiocode,windows
+# End of https://www.toptal.com/developers/gitignore/api/dotnetcore,linux,macos,unity,vim,visualstudiocode,windows
 
 ### THE PROJECT SPECIFIES #################################################
 
+### DotnetCore ###
+# DocFX
+**/DROP/
+**/TEMP/
+**/_site
+/Documents/**/packages/
+**/obj.meta
+
 ### Unity ###
 # Example scenes
 [Aa]ssets/Scenes*

.vscode/settings.json

@@ -2,8 +2,12 @@
   "files.associations": {
     "*.asmdef": "json",
     "*.asset": "yaml",
+    "*.mat": "yaml",
     "*.meta": "yaml",
+    "*.prefab": "yaml",
+    "*.unity": "css",
     "*.uss": "css",
+    ".manifest": "json",
     "LICENSE": "plaintext"
   },
   "files.readonlyInclude": {
@@ -22,6 +26,12 @@
     "UserSettings/**": true
   },
   "git.branchProtection": ["main"],
+  "json.schemas": [
+    {
+      "fileMatch": ["docfx.json"],
+      "url": "https://json.schemastore.org/docfx.json"
+    }
+  ],
   "search.exclude": {
     "**/*.suo": true,
     "Build/": true,
@@ -33,18 +43,29 @@
   },
   "yaml.customTags": [
     "tag:unity3d.com,2011:1 mapping",
+    "tag:unity3d.com,2011:4 mapping",
     "tag:unity3d.com,2011:5 mapping",
     "tag:unity3d.com,2011:11 mapping",
     "tag:unity3d.com,2011:13 mapping",
     "tag:unity3d.com,2011:19 mapping",
+    "tag:unity3d.com,2011:20 mapping",
+    "tag:unity3d.com,2011:21 mapping",
+    "tag:unity3d.com,2011:23 mapping",
     "tag:unity3d.com,2011:30 mapping",
+    "tag:unity3d.com,2011:33 mapping",
     "tag:unity3d.com,2011:47 mapping",
     "tag:unity3d.com,2011:55 mapping",
+    "tag:unity3d.com,2011:64 mapping",
     "tag:unity3d.com,2011:78 mapping",
+    "tag:unity3d.com,2011:81 mapping",
+    "tag:unity3d.com,2011:82 mapping",
+    "tag:unity3d.com,2011:108 mapping",
     "tag:unity3d.com,2011:114 mapping",
     "tag:unity3d.com,2011:126 mapping",
     "tag:unity3d.com,2011:129 mapping",
     "tag:unity3d.com,2011:159 mapping",
+    "tag:unity3d.com,2011:222 mapping",
+    "tag:unity3d.com,2011:224 mapping",
     "tag:unity3d.com,2011:236 mapping",
     "tag:unity3d.com,2011:310 mapping",
     "tag:unity3d.com,2011:1045 mapping",

Assets/PackageMakerWindowData.asset

@@ -0,0 +1,20 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!114 &11400000
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 0}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 0adae93375f5d5840a30b6e47f324172, type: 3}
+  m_Name: PackageMakerWindowData
+  m_EditorClassIdentifier: 
+  targetAssetFolder: 
+  packageID: 
+  authorName: 
+  authorEmail: 
+  authorUrl: 
+  relatedPackage: 0

Documentation/api/.gitignore

@@ -0,0 +1,5 @@
+###############
+#  temp file  #
+###############
+*.yml
+.manifest

Documentation/api/index.md

@@ -0,0 +1,3 @@
+# PLACEHOLDER
+
+TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!

Documentation/articles/intro.md

@@ -0,0 +1 @@
+# Add your introductions here

Documentation/articles/toc.yml

@@ -0,0 +1,2 @@
+- name: Introduction
+  href: intro.md

Documentation/docfx.json

@@ -0,0 +1,56 @@
+{
+  "build": {
+    "cleanupCacheHistory": false,
+    "content": [
+      {
+        "files": ["toc.yml", "index.md"]
+      },
+      {
+        "src": "api",
+        "files": ["*.yml", "index.md"],
+        "dest": "api"
+      }
+    ],
+    "disableGitFeatures": false,
+    "dest": "_site",
+    "fileMetadataFiles": [],
+    "globalMetadata": {
+      "_appTitle": "Example Unity documentation",
+      "_appFooter": "Example Unity documentation",
+      "_enableSearch": true
+    },
+    "globalMetadataFiles": [],
+    "keepFileLink": false,
+    "noLangKeyword": false,
+    "overwrite": [
+      {
+        "exclude": ["obj/**", "_site/**"],
+        "files": ["Packages/black.kit.toybox/**/*.md"],
+        "src": ".."
+      }
+    ],
+    "postProcessors": [],
+    "resource": [
+      {
+        "files": ["images/**"]
+      }
+    ],
+    "template": ["default"],
+    "xref": ["https://normanderwan.github.io/UnityXrefMaps/xrefmap.yml"],
+    "xrefService": ["https://xref.docs.microsoft.com/query?uid={uid}"]
+  },
+  "metadata": [
+    {
+      "dest": "api",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "filter": "filterConfig.yml",
+      "src": [
+        {
+          "files": ["Packages/black.kit.toybox/**/*.cs"],
+          "src": ".."
+        }
+      ]
+    }
+  ]
+}

Documentation/filterConfig.yml

@@ -0,0 +1,7 @@
+apiRules:
+- include:
+    type: Namespace
+    uidRegex: ^black\.kit\.toybox$
+- exclude:
+    type: Namespace
+    uidRegex: .*

Documentation/index.md

@@ -0,0 +1,52 @@
+# ![U# Toybox by Kuroné Kito](images/banner.png)
+
+My utilities library for the UdonSharp / VRChat
+
+## 💡 Features
+
+- 🖱 UI parts with global sync
+- 🫥 Object teleporter by turning the object on or off
+- 🔓 (Statically) whitelist gimmick
+- 🛎 Notify sound playing gimmick on player joined
+- 🗞 Publish-Subscribe pattern component
+- 🌈 Logger with vivid colors
+- ⚙️ Other features...
+
+## 💻 System Requirements
+
+- [VRChat Creator Companion](https://vrchat.com/home/download)
+- Unity 2022.3.6f1
+- 🏝 Project of your world
+
+## ▶ Getting Started
+
+### 1. Import the registry via the VRChat Creator Companion (VCC)
+
+(To be added)
+
+### 2. Import the UdonSharp Toybox package to your project
+
+(To be added)
+
+### 3. Use the utilities, enjoy :D
+
+Example:
+
+```csharp
+using black.kit.toybox;
+
+public class Example : UdonSharpBehaviour
+{
+    public void Start()
+    {
+      // Example of using the Contains extension method
+      var array = new[] { 1, 2, 3, 4, 5 };
+      Debug.Log($"Contains(3): {array.Contains(3)}");
+      Debug.Log($"Contains(6): {array.Contains(6)}");
+    }
+}
+```
+
+## License
+
+This repository is licensed under the **MIT License**.

Documentation/toc.yml

@@ -0,0 +1,3 @@
+- name: Api Documentation
+  href: api/
+  homepage: api/index.md

Packages/.gitignore

@@ -2,6 +2,5 @@
 !com.vrchat.core.*
 
 # Change this to match your new package name
-!com.vrchat.demo-template
 !com.vrchat.core.*/
 !black.kit.*

Packages/black.kit.toybox/Editor/AssemblyInfo.cs

@@ -0,0 +1,3 @@
+#if UNITY_EDITOR
+[assembly: UnityEditor.Localization]
+#endif