Skip to content

Commit

Permalink
feat(web): added the resources
Browse files Browse the repository at this point in the history
  • Loading branch information
kurone-kito committed Jun 30, 2024
1 parent aa3c9d3 commit 78cc9ff
Show file tree
Hide file tree
Showing 10 changed files with 267 additions and 2 deletions.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
"dependencies": {
"@solidjs/router": "^0.13.6",
"@solidjs/start": "^1.0.2",
"marked": "^13.0.1",
"solid-icons": "^1.1.0",
"solid-js": "^1.8.18",
"tw-elements": "^2.0.0"
Expand Down
10 changes: 10 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

147 changes: 147 additions & 0 deletions public/images/by-nc.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/illustrator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/svgfiles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 26 additions & 2 deletions scripts/createDynamicJson.mjs
Original file line number Diff line number Diff line change
@@ -1,15 +1,39 @@
import { readdir, writeFile } from 'node:fs/promises';
import { readdir, readFile, writeFile } from 'node:fs/promises';
import { parse } from 'marked';

/** icons directory */
const ICONS = 'public/icons';

/** destination file */
const DEST = 'src/dynamic.json';

/** texts directory */
const MDS = 'src/assets/texts';

/** icons list */
const icons = (await readdir(ICONS, { withFileTypes: true }))
.filter((file) => file.isFile() && file.name.endsWith('.svg'))
.map((file) => file.name.replace(/\.svg$/, ''))
.sort();

await writeFile(DEST, JSON.stringify({ icons }, null, 2));
/**
* empty texts
* @type {Readonly<Record<string, string>>}
*/
const emptyTexts = {};

const texts = await (
await readdir(MDS, { withFileTypes: true })
)
.filter((file) => file.isFile() && file.name.endsWith('.md'))
.reduce(
(acc, file) =>
acc.then(async (texts) => {
const key = file.name.replace(/\.md$/, '');
const text = await readFile(`${MDS}/${file.name}`, 'utf8');
return { ...texts, [key]: await parse(text) };
}),
Promise.resolve(emptyTexts),
);

await writeFile(DEST, JSON.stringify({ icons, texts }, null, 2));
8 changes: 8 additions & 0 deletions src/app.css
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,12 @@
.nav-icon-button {
@apply text-black/60 hover:text-black/80 dark:text-white/60 dark:hover:text-white/80;
}

.prose-article {
@apply article-container leading-loose prose prose-neutral dark:prose-invert prose-h2:text-surface dark:prose-h2:text-neutral-400;
}

.prose-anchor {
@apply prose-a:text-primary prose-a:transition prose-a:duration-150 prose-a:ease-in-out hover:prose-a:text-primary-600 focus:prose-a:text-primary-600 active:prose-a:text-primary-700 dark:prose-a:text-primary-400 dark:hover:prose-a:text-primary-500 dark:focus:prose-a:text-primary-500 dark:active:prose-a:text-primary-600;
}
}
21 changes: 21 additions & 0 deletions src/assets/texts/gettingStarted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- markdownlint-disable MD033 MD041 -->

### System requirements

- **<span translate="no">VRChat Creator Companion</span>** (Recommended)
- There is a bundled sample scene created in Unity _2022.3.22f1_;
we recommend previewing it using the same version.

### Installation

#### 1. Import the registry via the <span translate="no">VRChat Creator Companion (VCC)</span>

[Add to VCC](vcc://vpm/addRepo?url=https%3A%2F%2Fkurone-kito.github.io%2Fvpm%2Findex.json)

#### 2. Import the package to your project

1. Click on the “Manage Project” button in the VCC
2. Find the “<span translate="no">LaunchPad Icons</span>” package and
click on the “(+) Add package” button

#### 3. Use the package, enjoy :D
21 changes: 21 additions & 0 deletions src/assets/texts/manuallyInstallation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- markdownlint-disable MD033 MD041 -->

### Manually installation (not recommended)

#### 1. Download the package

Download the package from the
[latest release](https://github.com/kurone-kito/launchpad-icons/releases).

#### 2. Manually resolve the dependencies

The package requires the following dependencies:

- [<span translate="no">Unity Vector Graphics (com.unity.vectorgraphics)</span>](https://docs.unity3d.com/Packages/[email protected]/manual/index.html)
`>=2.0.0-preview.24`

#### 3. Import the package to your project

1. Open your Unity project
2. Drag and drop the downloaded package into the Unity Editor
3. Click on the “Import” button
Loading

0 comments on commit 78cc9ff

Please sign in to comment.