Skip to content

Commit 98b3787

Browse files
committed
[Docs] Added Github package installation token requirement
1 parent 94a2683 commit 98b3787

File tree

5 files changed

+23
-6
lines changed

5 files changed

+23
-6
lines changed
46.5 KB
Loading
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Mobile scripts (Android / IOS)
2+
3+
Put here any specific `C#` script for Mobile platforms.
4+
5+
> **PS:** For Mobile plugins, prefer use a folder structure from Unity guidelines such as:
6+
> [Unity Documentation: Import and configure plug-ins](https://docs.unity3d.com/Manual/PluginInspector.html)

Packages/com.benoitfreslon.vibration/Runtime/Scripts/Mobile/README.md.meta

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Packages/com.benoitfreslon.vibration/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"displayName": "Vibration",
55
"description": "Native free plugin for Unity for Android, iOS and WebGL. Use custom vibrations/haptics on mobile.",
66
"unity": "2019.3",
7-
"version": "0.1.7",
7+
"version": "0.1.8",
88
"keywords": [],
99
"devDependencies": {
1010
"cross-var": "^1.1.0",

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,11 @@ openupm add com.benoitfreslon.vibration
4848

4949
```
5050

51-
Or alternatively, merge the snippet below to [Packages/manifest.json](https://docs.unity3d.com/Manual/upm-manifestPrj.html) manually
51+
### OpenUPM package
52+
53+
Follow the installation guide from: [openupm/com.benoitfreslon.vibration](https://openupm.com/packages/com.benoitfreslon.vibration).
54+
55+
Alternatively, merge the snippet below to [Packages/manifest.json](https://docs.unity3d.com/Manual/upm-manifestPrj.html) manually
5256

5357
```jsonc
5458
{
@@ -72,7 +76,9 @@ Or alternatively, merge the snippet below to [Packages/manifest.json](https://do
7276

7377
### Github package
7478

75-
1. Add a **`$HOME/.upmconfig.toml`** file with the TOKEN to authenticate on registry
79+
1. Generate an **access token** on your Github account, following the guide: [Creating a personal access token (classic)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic).
80+
81+
2. Add a **`$HOME/.upmconfig.toml`** file with the TOKEN to authenticate on registry
7682

7783
```toml
7884
[npmAuth."https://npm.pkg.github.com/@mfdeveloper"]
@@ -83,9 +89,11 @@ Or alternatively, merge the snippet below to [Packages/manifest.json](https://do
8389
alwaysAuth = true
8490
```
8591

86-
> **WARNING:** _GitHub/Gitlab_ Packages registry always requires authentication. For **_private_** and **_public_** packages.
92+
> **WARNING:** _GitHub/Gitlab_ Packages registry always requires authentication. For **_private_** and **_public_** packages. If you don't have a Github account, or won't create a TOKEN, try use the [openupm](#openupm-package) package above.
93+
94+
![Github package authentication](./Images/github-package-auth-require-token.jpg)
8795

88-
2. Configure the scope **registry** and **dependency** in your Unity project `Packages/manifest.json`
96+
3. Configure the scope **registry** and **dependency** in your Unity project `Packages/manifest.json`
8997

9098
```jsonc
9199
{
@@ -237,7 +245,7 @@ Nope vibration: series of three weak booms (For iOS: only available with the hap
237245

238246
## Android Only
239247

240-
#### Custom duration in milliseconds
248+
### Custom duration in milliseconds
241249

242250
`Vibration.Vibrate(500);`
243251

0 commit comments

Comments
 (0)