Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tamakiruri/simpleitemlock

A easy way to stop non-members from using certain items in your VRChat World
https://github.com/tamakiruri/simpleitemlock

udon vrchat vrchat-world

Last synced: 2 months ago
JSON representation

A easy way to stop non-members from using certain items in your VRChat World

Awesome Lists containing this project

README 

        
# Simple Item Lock



![Sample](./Sample.png)



Simple Item Lock はVRChatワールドで、アイテムを特定の人にしか触れないようにしたり、見えないようにしたりするギミックです。



コライダーに動作するため、テレポーターなどにも動作します。



Simple Item Lock is a simple way to make your item being used or seen by using a white list.



It works with colliders, so items like teleporters will also work.



### 特徴 / Features



コライダーモード、無効モード選択可能 / Collider mode and disable mode available.



導入ツール付き / Ships with import tool.



選べるインスタンスオーナー許可 / Allow instance owner option available.



2つ以上共存可能 / Support for multiple locks to be used at same time.



ジョイン時に実行 / Runs at join.



パフォーマンス影響小 / Low performance cost.



Wall Mode: 指定した人だけがぬける壁（コライダー）、使えるテレポーターなどを作れます。



Use wall mode to make whitelisted players to go through certain walls or use teleporters etc.



### 注意事項 / Limitations



ジョイン時に実行されるため、ターゲットオブジェクトをスイッチでオンにするとスクリプトが無効になります。



そのため、ワールドでユーザーを追加したり、削除したりすることができません。



This script will be run at join, thus enabling the targets object with switches will make this script useless.



Therefore, adding or deleting whitelisted users in VRChat is not supported.



### 導入



3種類の導入方法があります。 / There are three ways to import this gimmick.



準備 / Preparation



1. Release でunitypackageをダウンロードします。 / Download at Release page.



2. Unityの**ワールド**プロジェクトに導入します。 / Import to a **World** project.



#### 導入ツールを利用する / Use the import tool



ツールバーのStudio Saphirタブで Item Lock Settingsを開きます。



Open Studio Saphir/Item Lock Settings at tool bar.



ユーザー名を入力します。入力できない場合では、右下の+マークを押してください。User Nameにあるすべてのユーザーがこのオブジェクトを操作できます。



Using the + mark at bottom right corner and input usernames for whitelisted users.



アイテムリストを作ります。Target Object は対象アイテムです。Action Mode 0では許可されないユーザーがオブジェクトを見えない（無効モード）、1では動かせないです。Allow Instance Ownerを有効にすれば、インスタンスを作った人が許可されます。WallModeでは、指定した人だけがぬける壁（コライダー）、使えるテレポーターなどを作れます。



Create the item list. At action mode 0 only whitelisted users can see the object, and at 1 only they can move the object. Use wall mode to make whitelisted players to go through certain walls or use teleporters etc.



**一番上のGenerate Dataを押す。この作業は毎回編集する時に必要になります。**



**Click the Generate Data Button at top. This should be done for every time the list is edited.**



ItemLockCenter(Managed)がシーンの中で配置されます。（動かさないようにしてください）Advanced Prefabと同じ方法で編集できます。



ItemLockCenter(Managed) will be placed at the scene. (Do not move this object) You can edit this using the same ways as advanced prefabs.



#### Prefabを利用する / Use the prefab



![Sample2](./Sample2.png)



2種類のPrefabがあります。 Advancedでは、アイテム一つ一つでインスタンスオーナーの許可を編集したり、モードを選択したりすることができますが、毎回Generate Dataを押す必要があります。Advanced がない方では、すべてのオブジェクトが同じような設定になります。設定の手順はほぼ同じです。



There are two types of prefabs. Advanced prefab allow editing modes and the options for allowing instance owner for each object, with a drawback of requiring clicking the Generate Data button every time the object is edited. The prefab without Advanced will let all target objects have the same settings.



ユーザー名を入力する。入力できない場合では、右下の+マークを押してください。User Nameにあるすべてのユーザーがこのオブジェクトを操作できます。



Using the + mark at bottom right corner and input usernames for whitelisted users.



アイテムリストを作ります。Target Object は対象アイテムです。Action Mode 0では許可されないユーザーがオブジェクトを見えない（無効モード）、1では動かせないです。Allow Instance Ownerを有効にすれば、インスタンスを作った人が許可されます。WallModeでは、指定した人だけがぬける壁（コライダー）、使えるテレポーターなどを作れます。



Create the item list. At action mode 0 only whitelisted users can see the object, and at 1 only they can move the object. Use wall mode to make whitelisted players to go through certain walls or use teleporters etc.



**Advanced PrefabではGenerate Dataを押す。この作業は毎回編集する時に必要になります。**



**Click the Generate Data Button for Advanced Prefab. This should be done for every time the list is edited.**



#### 一つオブジェクトのみ利用する / Use single object script



対象オブジェクトにItemLockUsernameというスクリプトをD&Dします。



Drag and drop ItemLockUsername script to target object.



ユーザー名を入力する。入力できない場合では、右下の+マークを押してください。User Nameにあるすべてのユーザーがこのオブジェクトを操作できます。



Using the + mark at bottom right corner and input usernames for whitelisted users.



Action Mode 0では許可されないユーザーがオブジェクトを見えない（無効モード）、1では動かせないです。Allow Instance Ownerを有効にすれば、インスタンスを作った人が許可されます。Wall Modeを有効にすれば、特定の人しか通れない壁が作れます。



At action mode 0 only whitelisted users can see the object, and at 1 only they can move the object. Use wall mode to make whitelisted players to go through certain walls or use teleporters etc.