diff --git a/packages/apps/browser/README.md b/packages/apps/browser/README.md index 3ad845f..37aa12a 100644 --- a/packages/apps/browser/README.md +++ b/packages/apps/browser/README.md @@ -64,13 +64,15 @@ url: string; ## Links -- [Website/demo][website] +- [Demo][demo] +- [Docs][docs] - [GitHub][github] - [npm][npm] - [Discord][discord] - [Ko-fi][ko-fi] -[website]: https://os.prozilla.dev/browser +[demo]: https://os.prozilla.dev/browser +[docs]: https://os.prozilla.dev/docs/reference/apps/browser [github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/browser [npm]: https://www.npmjs.com/package/@prozilla-os/browser [discord]: https://discord.gg/JwbyQP4tdz diff --git a/packages/apps/calculator/README.md b/packages/apps/calculator/README.md index 3fbf19d..ac8b3a6 100644 --- a/packages/apps/calculator/README.md +++ b/packages/apps/calculator/README.md @@ -55,13 +55,15 @@ function App() { ## Links -- [Website/demo][website] +- [Demo][demo] +- [Docs][docs] - [GitHub][github] - [npm][npm] - [Discord][discord] - [Ko-fi][ko-fi] -[website]: https://os.prozilla.dev/calculator +[demo]: https://os.prozilla.dev/calculator +[docs]: https://os.prozilla.dev/docs/reference/apps/calculator [github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/calculator [npm]: https://www.npmjs.com/package/@prozilla-os/calculator [discord]: https://discord.gg/JwbyQP4tdz diff --git a/packages/apps/file-explorer/README.md b/packages/apps/file-explorer/README.md index bb1267d..137aa74 100644 --- a/packages/apps/file-explorer/README.md +++ b/packages/apps/file-explorer/README.md @@ -90,13 +90,15 @@ onSelectionFinish: Function; ## Links -- [Website/demo][website] +- [Demo][demo] +- [Docs][docs] - [GitHub][github] - [npm][npm] - [Discord][discord] - [Ko-fi][ko-fi] -[website]: https://os.prozilla.dev/file-explorer +[demo]: https://os.prozilla.dev/file-explorer +[docs]: https://os.prozilla.dev/docs/reference/apps/file-explorer [github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/file-explorer [npm]: https://www.npmjs.com/package/@prozilla-os/file-explorer [discord]: https://discord.gg/JwbyQP4tdz diff --git a/packages/apps/logic-sim/README.md b/packages/apps/logic-sim/README.md index 8d71d8d..41be617 100644 --- a/packages/apps/logic-sim/README.md +++ b/packages/apps/logic-sim/README.md @@ -55,13 +55,15 @@ function App() { ## Links -- [Website/demo][website] +- [Demo][demo] +- [Docs][docs] - [GitHub][github] - [npm][npm] - [Discord][discord] - [Ko-fi][ko-fi] -[website]: https://os.prozilla.dev/logic-sim +[demo]: https://os.prozilla.dev/logic-sim +[docs]: https://os.prozilla.dev/docs/reference/apps/logic-sim [github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/logic-sim [npm]: https://www.npmjs.com/package/@prozilla-os/logic-sim [discord]: https://discord.gg/JwbyQP4tdz diff --git a/packages/apps/media-viewer/README.md b/packages/apps/media-viewer/README.md index 223f6a9..54d59bd 100644 --- a/packages/apps/media-viewer/README.md +++ b/packages/apps/media-viewer/README.md @@ -64,13 +64,15 @@ file: VirtualFile; ## Links -- [Website/demo][website] +- [Demo][demo] +- [Docs][docs] - [GitHub][github] - [npm][npm] - [Discord][discord] - [Ko-fi][ko-fi] -[website]: https://os.prozilla.dev/media-viewer +[demo]: https://os.prozilla.dev/media-viewer +[docs]: https://os.prozilla.dev/docs/reference/apps/media-viewer [github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/media-viewer [npm]: https://www.npmjs.com/package/@prozilla-os/media-viewer [discord]: https://discord.gg/JwbyQP4tdz diff --git a/packages/apps/settings/README.md b/packages/apps/settings/README.md index 6530212..ec95ba3 100644 --- a/packages/apps/settings/README.md +++ b/packages/apps/settings/README.md @@ -65,13 +65,15 @@ tab: number; ## Links -- [Website/demo][website] +- [Demo][demo] +- [Docs][docs] - [GitHub][github] - [npm][npm] - [Discord][discord] - [Ko-fi][ko-fi] -[website]: https://os.prozilla.dev/settings +[demo]: https://os.prozilla.dev/settings +[docs]: https://os.prozilla.dev/docs/reference/apps/settings [github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/settings [npm]: https://www.npmjs.com/package/@prozilla-os/settings [discord]: https://discord.gg/JwbyQP4tdz diff --git a/packages/apps/terminal/README.md b/packages/apps/terminal/README.md index 33ab231..7bfbe6a 100644 --- a/packages/apps/terminal/README.md +++ b/packages/apps/terminal/README.md @@ -70,13 +70,15 @@ input: string; ## Links -- [Website/demo][website] +- [Demo][demo] +- [Docs][docs] - [GitHub][github] - [npm][npm] - [Discord][discord] - [Ko-fi][ko-fi] -[website]: https://os.prozilla.dev/terminal +[demo]: https://os.prozilla.dev/terminal +[docs]: https://os.prozilla.dev/docs/reference/apps/terminal [github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/terminal [npm]: https://www.npmjs.com/package/@prozilla-os/terminal [discord]: https://discord.gg/JwbyQP4tdz diff --git a/packages/apps/text-editor/README.md b/packages/apps/text-editor/README.md index 32cd23d..a80b338 100644 --- a/packages/apps/text-editor/README.md +++ b/packages/apps/text-editor/README.md @@ -77,13 +77,15 @@ mode: "view" | "edit"; ## Links -- [Website/demo][website] +- [Demo][demo] +- [Docs][docs] - [GitHub][github] - [npm][npm] - [Discord][discord] - [Ko-fi][ko-fi] -[website]: https://os.prozilla.dev/text-editor +[demo]: https://os.prozilla.dev/text-editor +[docs]: https://os.prozilla.dev/docs/reference/apps/text-editor [github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/text-editor [npm]: https://www.npmjs.com/package/@prozilla-os/text-editor [discord]: https://discord.gg/JwbyQP4tdz diff --git a/packages/core/README.md b/packages/core/README.md index 77ef859..ec8a164 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -44,15 +44,43 @@ function App() {
-### `` props +### Configuration ```tsx -{ +interface ProzillaOSProps { systemName: string, tagLine: string, + skin: new Skin({ + + appIcons: Record | undefined, + + appNames: Record | undefined, + + wallpapers: string[], + + defaultWallpaper: string, + + fileIcons: { + generic: string; + info: string | undefined; + text: string | undefined; + code: string | undefined; + }, + + folderIcons: { + generic: string; + images: string | undefined; + text: string | undefined; + link: string | undefined; + }, + + loadStyleSheet: () => void | undefined + + }) + config: { apps: new AppsConfig({ @@ -61,12 +89,6 @@ function App() { }), desktop: new DesktopConfig({ - /** Array of URLs of wallpaper images */ - wallpapers: string[], - - /** URL of default wallpaper image */ - defaultWallpaper: string, - /** * @default 1 */ @@ -79,6 +101,14 @@ function App() { defaultIconDirection: 0 | 1 }), + misc: new MiscConfig({ + + /** + * @default 250 + */ + doubleClickDelay: number + + }) modals: new ModalsConfig({ /** @@ -114,19 +144,6 @@ function App() { /** Google Analytics measurement ID */ GAMeasurementId: string - }), - virtualDrive: new VirtualDriveConfig({ - - fileIcon: string, - infoFileIcon: string, - textFileIcon: string, - codeFileIcon: string, - - folderIcon: string, - imagesFolderIcon: string, - textFolderIcon: string, - folderLinkIcon: string - }), windows: new WindowsConfig({ @@ -154,13 +171,15 @@ function App() { ## Links -- [Website/demo][website] +- [Demo][demo] +- [Docs][docs] - [GitHub][github] - [npm][npm] - [Discord][discord] - [Ko-fi][ko-fi] -[website]: https://os.prozilla.dev/ +[demo]: https://os.prozilla.dev/ +[docs]: https://os.prozilla.dev/docs/reference/core [github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/core [npm]: https://www.npmjs.com/package/@prozilla-os/core [discord]: https://discord.gg/JwbyQP4tdz diff --git a/packages/demo/README.md b/packages/demo/README.md index 08e89dd..ddbda39 100644 --- a/packages/demo/README.md +++ b/packages/demo/README.md @@ -35,7 +35,7 @@ - [Discord][discord] - [Ko-fi][ko-fi] -[website]: https://os.prozilla.dev/ +[demo]: https://os.prozilla.dev/ [github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/demo [discord]: https://discord.gg/JwbyQP4tdz [ko-fi]: https://ko-fi.com/prozilla \ No newline at end of file diff --git a/packages/docs/.vitepress/config.ts b/packages/docs/.vitepress/config.ts index 26da00c..37c532a 100644 --- a/packages/docs/.vitepress/config.ts +++ b/packages/docs/.vitepress/config.ts @@ -1,9 +1,6 @@ import { defineConfig, HeadConfig } from "vitepress"; - -const TITLE = "ProzillaOS Docs"; -const DESCRIPTION = "Documentation for ProzillaOS and its packages."; -const LOCALE = "en_US"; -const IMAGE = "https://os.prozilla.dev/docs/prozilla-os-title-banner.png"; +import { packageReferenceItems, PACKAGES, packageSidebars } from "./packages.config"; +import { DESCRIPTION, IMAGE, LOCALE, TITLE } from "./meta.config"; // https://vitepress.dev/reference/site-config export default defineConfig({ @@ -64,75 +61,22 @@ export default defineConfig({ base: "/reference/", items: [ { - text: "Overview", + text: "Reference", items: [ { text: "Configuration", link: "/configuration" }, - { text: "Packages", link: "/packages" }, { text: "Glossary", link: "/glossary" }, - ] + ], }, { - text: "Classes", - base: "/reference/classes/", - collapsed: false, + text: "Packages", items: [ - { - text: "Apps", - base: "/reference/classes/apps/", - collapsed: true, - items: [ - { text: "App", link: "app" }, - ] - }, - { - text: "Skins", - base: "/reference/classes/skins/", - collapsed: true, - items: [ - { text: "Skin", link: "skin" }, - ] - }, - { - text: "System", - base: "/reference/classes/system/", - collapsed: true, - items: [ - { text: "AppsConfig", link: "apps-config" }, - { text: "DesktopConfig", link: "desktop-config" }, - { text: "MiscConfig", link: "misc-config" }, - { text: "ModalsConfig", link: "modals-config" }, - { text: "TaskbarConfig", link: "taskbar-config" }, - { text: "TrackingConfig", link: "tracking-config" }, - { text: "WindowsConfig", link: "windows-config" }, - ] - }, - { - text: "Utils", - base: "/reference/classes/utils/", - collapsed: true, - items: [ - { text: "Vector2", link: "vector2" }, - ] - }, + { text: "Overview", link: "/packages" }, + ...packageReferenceItems(PACKAGES) ] - }, - { - text: "Functions", - base: "/reference/functions/", - collapsed: false, - items: [ - { text: "Array", link: "/array" }, - { text: "Browser", link: "/browser" }, - { text: "Date", link: "/date" }, - { text: "Math", link: "/math" }, - ] - }, - { - text: "Constants", - link: "constants" - }, + } ] }, + ...packageSidebars(PACKAGES), }, editLink: { diff --git a/packages/docs/.vitepress/meta.config.ts b/packages/docs/.vitepress/meta.config.ts new file mode 100644 index 0000000..f273c07 --- /dev/null +++ b/packages/docs/.vitepress/meta.config.ts @@ -0,0 +1,4 @@ +export const TITLE = "ProzillaOS Docs"; +export const DESCRIPTION = "Documentation for ProzillaOS and its packages."; +export const LOCALE = "en_US"; +export const IMAGE = "https://os.prozilla.dev/docs/prozilla-os-title-banner.png"; \ No newline at end of file diff --git a/packages/docs/.vitepress/packages.config.ts b/packages/docs/.vitepress/packages.config.ts new file mode 100644 index 0000000..eabd31d --- /dev/null +++ b/packages/docs/.vitepress/packages.config.ts @@ -0,0 +1,168 @@ +import { DefaultTheme } from "vitepress"; + +export interface PackageData { + text: string; + link: string; + items?: DefaultTheme.SidebarItem[]; + category: "Libraries" | "Standard apps" | "Non-standard apps"; +}; + +export const PACKAGES: PackageData[] = [ + { + text: "prozilla-os", + link: "prozilla-os", + category: "Libraries" + }, + { + text: "@prozilla-os/core", + link: "core", + category: "Libraries", + items: [ + { + text: "Classes", + base: "/reference/core/classes/", + collapsed: false, + items: [ + { + text: "Apps", + base: "/reference/core/classes/apps/", + collapsed: true, + items: [ + { text: "App", link: "app" }, + ] + }, + { + text: "System", + base: "/reference/core/classes/system/", + collapsed: true, + items: [ + { text: "AppsConfig", link: "apps-config" }, + { text: "DesktopConfig", link: "desktop-config" }, + { text: "MiscConfig", link: "misc-config" }, + { text: "ModalsConfig", link: "modals-config" }, + { text: "TaskbarConfig", link: "taskbar-config" }, + { text: "TrackingConfig", link: "tracking-config" }, + { text: "WindowsConfig", link: "windows-config" }, + ] + }, + { + text: "Utils", + base: "/reference/core/classes/utils/", + collapsed: true, + items: [ + { text: "Vector2", link: "vector2" }, + ] + }, + ] + }, + { + text: "Functions", + base: "/reference/core/functions/", + collapsed: false, + items: [ + { text: "Array", link: "/array" }, + { text: "Browser", link: "/browser" }, + { text: "Date", link: "/date" }, + { text: "Math", link: "/math" }, + ] + }, + { + text: "Constants", + link: "constants" + }, + ] + }, + { + text: "@prozilla-os/skins", + link: "skins", + category: "Libraries", + items: [ + { + text: "Classes", + base: "/reference/skins/classes/", + collapsed: false, + items: [ + { text: "Skin", link: "skin" } + ] + } + ] + }, + { + text: "@prozilla-os/shared", + link: "shared", + category: "Libraries", + }, + { + text: "@prozilla-os/calculator", + link: "apps/calculator", + category: "Standard apps", + }, + { + text: "@prozilla-os/file-explorer", + link: "apps/file-explorer", + category: "Standard apps", + }, + { + text: "@prozilla-os/media-viewer", + link: "apps/media-viewer", + category: "Standard apps", + }, + { + text: "@prozilla-os/settings", + link: "apps/settings", + category: "Standard apps", + }, + { + text: "@prozilla-os/terminal", + link: "apps/terminal", + category: "Standard apps", + }, + { + text: "@prozilla-os/logic-sim", + link: "apps/logic-sim", + category: "Non-standard apps", + } +]; + +export const packageSidebars = (packages: PackageData[]): DefaultTheme.Sidebar => { + const sidebar: DefaultTheme.Sidebar = {}; + + packages.forEach(({ text, link, items = [] }) => { + const base = `/reference/${link}/`; + sidebar[base] = { + base, + items: [ + { + text, + items: [ + { text: "Info", link: "/" }, + ...items + ] + } + ] + }; + }); + + return sidebar; +}; + +export const packageReferenceItems = (packages: PackageData[]): DefaultTheme.SidebarItem[] => { + const categories: Record = {}; + + packages.forEach(({ text, link, category }) => { + if (!Object.keys(categories).includes(category)) { + categories[category] = { + text: category, + collapsed: true, + items: [] + }; + } + + categories[category].items?.push({ + text, + link + }); + }); + + return Object.values(categories); +}; \ No newline at end of file diff --git a/packages/docs/src/reference/apps/browser/index.md b/packages/docs/src/reference/apps/browser/index.md new file mode 100644 index 0000000..d03f035 --- /dev/null +++ b/packages/docs/src/reference/apps/browser/index.md @@ -0,0 +1,7 @@ +--- +outline: deep +--- + +# @prozilla-os/browser + + \ No newline at end of file diff --git a/packages/docs/src/reference/apps/calculator/index.md b/packages/docs/src/reference/apps/calculator/index.md new file mode 100644 index 0000000..dcada24 --- /dev/null +++ b/packages/docs/src/reference/apps/calculator/index.md @@ -0,0 +1,7 @@ +--- +outline: deep +--- + +# @prozilla-os/calculator + + \ No newline at end of file diff --git a/packages/docs/src/reference/apps/file-explorer/index.md b/packages/docs/src/reference/apps/file-explorer/index.md new file mode 100644 index 0000000..f2e2109 --- /dev/null +++ b/packages/docs/src/reference/apps/file-explorer/index.md @@ -0,0 +1,7 @@ +--- +outline: deep +--- + +# @prozilla-os/file-explorer + + \ No newline at end of file diff --git a/packages/docs/src/reference/apps/logic-sim/index.md b/packages/docs/src/reference/apps/logic-sim/index.md new file mode 100644 index 0000000..04c3a00 --- /dev/null +++ b/packages/docs/src/reference/apps/logic-sim/index.md @@ -0,0 +1,7 @@ +--- +outline: deep +--- + +# @prozilla-os/logic-sim + + \ No newline at end of file diff --git a/packages/docs/src/reference/apps/media-viewer/index.md b/packages/docs/src/reference/apps/media-viewer/index.md new file mode 100644 index 0000000..ec9ef51 --- /dev/null +++ b/packages/docs/src/reference/apps/media-viewer/index.md @@ -0,0 +1,7 @@ +--- +outline: deep +--- + +# @prozilla-os/media-viewer + + \ No newline at end of file diff --git a/packages/docs/src/reference/apps/settings/index.md b/packages/docs/src/reference/apps/settings/index.md new file mode 100644 index 0000000..8929e95 --- /dev/null +++ b/packages/docs/src/reference/apps/settings/index.md @@ -0,0 +1,7 @@ +--- +outline: deep +--- + +# @prozilla-os/settings + + \ No newline at end of file diff --git a/packages/docs/src/reference/apps/terminal/index.md b/packages/docs/src/reference/apps/terminal/index.md new file mode 100644 index 0000000..18e7892 --- /dev/null +++ b/packages/docs/src/reference/apps/terminal/index.md @@ -0,0 +1,7 @@ +--- +outline: deep +--- + +# @prozilla-os/terminal + + \ No newline at end of file diff --git a/packages/docs/src/reference/configuration.md b/packages/docs/src/reference/configuration.md index 6f42fdd..e43cbe6 100644 --- a/packages/docs/src/reference/configuration.md +++ b/packages/docs/src/reference/configuration.md @@ -29,7 +29,7 @@ Tag line or short description of the system Configurations for assets, stylesheets and other visual elements - **Optional** -- **Type:** [`Skin`](/reference/classes/skins/skin) +- **Type:** [`Skin`](/reference/core/skins/classes/skin) - **Default:** `new Skin()` ### config @@ -52,13 +52,13 @@ interface ConfigOptions { ``` > [!NOTE] References -> - [AppsConfig](/reference/classes/system/apps-config) -> - [DesktopConfig](/reference/classes/system/desktop-config) -> - [MiscConfig](/reference/classes/system/misc-config) -> - [ModalsConfig](/reference/classes/system/modals-config) -> - [TaskbarConfig](/reference/classes/system/taskbar-config) -> - [TrackingConfig](/reference/classes/system/tracking-config) -> - [WindowsConfig](/reference/classes/system/windows-config) +> - [AppsConfig](/reference/core/classes/system/apps-config) +> - [DesktopConfig](/reference/core/classes/system/desktop-config) +> - [MiscConfig](/reference/core/classes/system/misc-config) +> - [ModalsConfig](/reference/core/classes/system/modals-config) +> - [TaskbarConfig](/reference/core/classes/system/taskbar-config) +> - [TrackingConfig](/reference/core/classes/system/tracking-config) +> - [WindowsConfig](/reference/core/classes/system/windows-config) ## Example diff --git a/packages/docs/src/reference/classes/apps/app.md b/packages/docs/src/reference/core/classes/apps/app.md similarity index 100% rename from packages/docs/src/reference/classes/apps/app.md rename to packages/docs/src/reference/core/classes/apps/app.md diff --git a/packages/docs/src/reference/classes/system/apps-config.md b/packages/docs/src/reference/core/classes/system/apps-config.md similarity index 81% rename from packages/docs/src/reference/classes/system/apps-config.md rename to packages/docs/src/reference/core/classes/system/apps-config.md index 9255823..3bf6c3c 100644 --- a/packages/docs/src/reference/classes/system/apps-config.md +++ b/packages/docs/src/reference/core/classes/system/apps-config.md @@ -25,7 +25,7 @@ interface AppsConfigOptions { ``` > [!NOTE] References -> - [App](/reference/classes/apps/app) +> - [App](/reference/core/classes/apps/app) ## Properties @@ -33,4 +33,4 @@ interface AppsConfigOptions { An array of applications -- **Type:** [`App[]`](../apps/app) +- **Type:** [`App[]`](/reference/core/classes/apps/app) diff --git a/packages/docs/src/reference/classes/system/desktop-config.md b/packages/docs/src/reference/core/classes/system/desktop-config.md similarity index 100% rename from packages/docs/src/reference/classes/system/desktop-config.md rename to packages/docs/src/reference/core/classes/system/desktop-config.md diff --git a/packages/docs/src/reference/classes/system/misc-config.md b/packages/docs/src/reference/core/classes/system/misc-config.md similarity index 100% rename from packages/docs/src/reference/classes/system/misc-config.md rename to packages/docs/src/reference/core/classes/system/misc-config.md diff --git a/packages/docs/src/reference/classes/system/modals-config.md b/packages/docs/src/reference/core/classes/system/modals-config.md similarity index 78% rename from packages/docs/src/reference/classes/system/modals-config.md rename to packages/docs/src/reference/core/classes/system/modals-config.md index 78777e6..520d25e 100644 --- a/packages/docs/src/reference/classes/system/modals-config.md +++ b/packages/docs/src/reference/core/classes/system/modals-config.md @@ -26,7 +26,7 @@ interface ModalsConfigOptions { ``` > [!NOTE] References -> - [Vector2](/reference/classes/utils/vector2) +> - [Vector2](/reference/core/classes/utils/vector2) ## Properties @@ -34,12 +34,12 @@ interface ModalsConfigOptions { Default size of a dialog box -- **Type:** [`Vector2`](/reference/classes/utils/vector2) +- **Type:** [`Vector2`](/reference/core/classes/utils/vector2) - **Default:** `new Vector2(400, 200)` ### defaultFileSelectorSize Default size of a file selector -- **Type:** [`Vector2`](/reference/classes/utils/vector2) +- **Type:** [`Vector2`](/reference/core/classes/utils/vector2) - **Default:** `new Vector2(700, 400)` diff --git a/packages/docs/src/reference/classes/system/taskbar-config.md b/packages/docs/src/reference/core/classes/system/taskbar-config.md similarity index 100% rename from packages/docs/src/reference/classes/system/taskbar-config.md rename to packages/docs/src/reference/core/classes/system/taskbar-config.md diff --git a/packages/docs/src/reference/classes/system/tracking-config.md b/packages/docs/src/reference/core/classes/system/tracking-config.md similarity index 100% rename from packages/docs/src/reference/classes/system/tracking-config.md rename to packages/docs/src/reference/core/classes/system/tracking-config.md diff --git a/packages/docs/src/reference/classes/system/windows-config.md b/packages/docs/src/reference/core/classes/system/windows-config.md similarity index 90% rename from packages/docs/src/reference/classes/system/windows-config.md rename to packages/docs/src/reference/core/classes/system/windows-config.md index 709263c..4dc083b 100644 --- a/packages/docs/src/reference/classes/system/windows-config.md +++ b/packages/docs/src/reference/core/classes/system/windows-config.md @@ -27,7 +27,7 @@ interface WindowsConfigOptions { ``` > [!NOTE] References -> - [Vector2](/reference/classes/utils/vector2) +> - [Vector2](/reference/core/classes/utils/vector2) ## Properties @@ -49,7 +49,7 @@ A string that is placed between different parts of a window title If the user's screen is smaller than these values, windows will always be maximized -- **Type:** [`Vector2`](/reference/classes/utils/vector2) +- **Type:** [`Vector2`](/reference/core/classes/utils/vector2) - **Default:** `new Vector2(350, 350)` > [!WARNING] diff --git a/packages/docs/src/reference/classes/utils/vector2.md b/packages/docs/src/reference/core/classes/utils/vector2.md similarity index 100% rename from packages/docs/src/reference/classes/utils/vector2.md rename to packages/docs/src/reference/core/classes/utils/vector2.md diff --git a/packages/docs/src/reference/constants/index.md b/packages/docs/src/reference/core/constants/index.md similarity index 100% rename from packages/docs/src/reference/constants/index.md rename to packages/docs/src/reference/core/constants/index.md diff --git a/packages/docs/src/reference/functions/array.md b/packages/docs/src/reference/core/functions/array.md similarity index 100% rename from packages/docs/src/reference/functions/array.md rename to packages/docs/src/reference/core/functions/array.md diff --git a/packages/docs/src/reference/functions/browser.md b/packages/docs/src/reference/core/functions/browser.md similarity index 100% rename from packages/docs/src/reference/functions/browser.md rename to packages/docs/src/reference/core/functions/browser.md diff --git a/packages/docs/src/reference/functions/date.md b/packages/docs/src/reference/core/functions/date.md similarity index 100% rename from packages/docs/src/reference/functions/date.md rename to packages/docs/src/reference/core/functions/date.md diff --git a/packages/docs/src/reference/functions/math.md b/packages/docs/src/reference/core/functions/math.md similarity index 100% rename from packages/docs/src/reference/functions/math.md rename to packages/docs/src/reference/core/functions/math.md diff --git a/packages/docs/src/reference/core/index.md b/packages/docs/src/reference/core/index.md new file mode 100644 index 0000000..7f41af3 --- /dev/null +++ b/packages/docs/src/reference/core/index.md @@ -0,0 +1,7 @@ +--- +outline: deep +--- + +# @prozilla-os/core + + \ No newline at end of file diff --git a/packages/docs/src/reference/packages.md b/packages/docs/src/reference/packages.md index 2120191..5e28717 100644 --- a/packages/docs/src/reference/packages.md +++ b/packages/docs/src/reference/packages.md @@ -6,23 +6,6 @@ outline: deep These packages are different modules of ProzillaOS that can be installed separately or via the bundle package `prozilla-os`. -## Main +### Libraries -- [`prozilla-os`](https://www.npmjs.com/package/prozilla-os): A bundle containing `@prozilla-os/core` and all standard applications -- [`@prozilla-os/core`](https://www.npmjs.com/package/@prozilla-os/core): Core functionality, React components and hooks -- [`@prozilla-os/skins`](https://www.npmjs.com/package/@prozilla-os/skins): Customizable skins for ProzillaOS -- [`@prozilla-os/shared`](https://www.npmjs.com/package/@prozilla-os/shared): Shared functions and utilities - -## Standard applications - -- [`@prozilla-os/file-explorer`](https://www.npmjs.com/package/@prozilla-os/file-explorer): File explorer app -- [`@prozilla-os/terminal`](https://www.npmjs.com/package/@prozilla-os/terminal): Terminal/shell app -- [`@prozilla-os/text-editor`](https://www.npmjs.com/package/@prozilla-os/text-editor): Text editor app -- [`@prozilla-os/settings`](https://www.npmjs.com/package/@prozilla-os/settings): Settings app -- [`@prozilla-os/media-viewer`](https://www.npmjs.com/package/@prozilla-os/media-viewer): Media viewer app -- [`@prozilla-os/browser`](https://www.npmjs.com/package/@prozilla-os/browser): Browser app -- [`@prozilla-os/calculator`](https://www.npmjs.com/package/@prozilla-os/calculator): Calculator app - -## Non-standard applications - -- [`@prozilla-os/logic-sim`](https://www.npmjs.com/package/@prozilla-os/logic-sim): Digital logic simulator app \ No newline at end of file + diff --git a/packages/docs/src/reference/prozilla-os/index.md b/packages/docs/src/reference/prozilla-os/index.md new file mode 100644 index 0000000..57785a2 --- /dev/null +++ b/packages/docs/src/reference/prozilla-os/index.md @@ -0,0 +1,7 @@ +--- +outline: deep +--- + +# prozilla-os + + \ No newline at end of file diff --git a/packages/docs/src/reference/shared/index.md b/packages/docs/src/reference/shared/index.md new file mode 100644 index 0000000..8b3dbc7 --- /dev/null +++ b/packages/docs/src/reference/shared/index.md @@ -0,0 +1,7 @@ +--- +outline: deep +--- + +# @prozilla-os/shared + + \ No newline at end of file diff --git a/packages/docs/src/reference/classes/skins/skin.md b/packages/docs/src/reference/skins/classes/skin.md similarity index 100% rename from packages/docs/src/reference/classes/skins/skin.md rename to packages/docs/src/reference/skins/classes/skin.md diff --git a/packages/docs/src/reference/skins/index.md b/packages/docs/src/reference/skins/index.md new file mode 100644 index 0000000..f953756 --- /dev/null +++ b/packages/docs/src/reference/skins/index.md @@ -0,0 +1,7 @@ +--- +outline: deep +--- + +# @prozilla-os/skins + + \ No newline at end of file diff --git a/packages/prozilla-os/README.md b/packages/prozilla-os/README.md index e18e419..d56e4c9 100644 --- a/packages/prozilla-os/README.md +++ b/packages/prozilla-os/README.md @@ -15,7 +15,7 @@ `prozilla-os` is a React Vite component library written in TypeScript for building web-based operating systems, made by Prozilla. This package combines multiple other packages for easy access to different ProzillaOS features. You can also download these packages separately instead. -**Live demo: [os.prozilla.dev][website]** - [(source)][website-source] +**Live demo: [os.prozilla.dev][demo]** - [(source)][website-source] ## Installation @@ -61,15 +61,43 @@ function App() {
-### `` props +### Configuration ```tsx -{ +interface ProzillaOSProps { systemName: string, tagLine: string, + skin: new Skin({ + + appIcons: Record | undefined, + + appNames: Record | undefined, + + wallpapers: string[], + + defaultWallpaper: string, + + fileIcons: { + generic: string; + info: string | undefined; + text: string | undefined; + code: string | undefined; + }, + + folderIcons: { + generic: string; + images: string | undefined; + text: string | undefined; + link: string | undefined; + }, + + loadStyleSheet: () => void | undefined + + }) + config: { apps: new AppsConfig({ @@ -78,12 +106,6 @@ function App() { }), desktop: new DesktopConfig({ - /** Array of URLs of wallpaper images */ - wallpapers: string[], - - /** URL of default wallpaper image */ - defaultWallpaper: string, - /** * @default 1 */ @@ -96,6 +118,14 @@ function App() { defaultIconDirection: 0 | 1 }), + misc: new MiscConfig({ + + /** + * @default 250 + */ + doubleClickDelay: number + + }) modals: new ModalsConfig({ /** @@ -131,19 +161,6 @@ function App() { /** Google Analytics measurement ID */ GAMeasurementId: string - }), - virtualDrive: new VirtualDriveConfig({ - - fileIcon: string, - infoFileIcon: string, - textFileIcon: string, - codeFileIcon: string, - - folderIcon: string, - imagesFolderIcon: string, - textFolderIcon: string, - folderLinkIcon: string - }), windows: new WindowsConfig({ @@ -171,13 +188,15 @@ function App() { ## Links -- [Website/demo][website] +- [Demo][demo] +- [Docs][docs] - [GitHub][github] - [npm][npm] - [Discord][discord] - [Ko-fi][ko-fi] -[website]: https://os.prozilla.dev/ +[demo]: https://os.prozilla.dev/ +[docs]: [docs]: https://os.prozilla.dev/docs/reference/prozilla-os [website-source]: https://github.com/prozilla-os/ProzillaOS [github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/prozilla-os [npm]: https://www.npmjs.com/package/prozilla-os diff --git a/packages/shared/README.md b/packages/shared/README.md index 354ff3f..bf46f41 100644 --- a/packages/shared/README.md +++ b/packages/shared/README.md @@ -48,13 +48,15 @@ export default defineConfig({ ## Links -- [Website/demo][website] +- [Demo][demo] +- [Docs][docs] - [GitHub][github] - [npm][npm] - [Discord][discord] - [Ko-fi][ko-fi] -[website]: https://os.prozilla.dev/ +[demo]: https://os.prozilla.dev/ +[docs]: [docs]: https://os.prozilla.dev/docs/reference/shared [github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/shared [npm]: https://www.npmjs.com/package/@prozilla-os/shared [discord]: https://discord.gg/JwbyQP4tdz diff --git a/packages/skins/README.md b/packages/skins/README.md index d99b1de..4292768 100644 --- a/packages/skins/README.md +++ b/packages/skins/README.md @@ -25,13 +25,15 @@ $ pnpm add @prozilla-os/skins ## Links -- [Website/demo][website] +- [Demo][demo] +- [Docs][docs] - [GitHub][github] - [npm][npm] - [Discord][discord] - [Ko-fi][ko-fi] -[website]: https://os.prozilla.dev/ +[demo]: https://os.prozilla.dev/ +[docs]: https://os.prozilla.dev/docs/reference/skins [github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/skins [npm]: https://www.npmjs.com/package/@prozilla-os/skins [discord]: https://discord.gg/JwbyQP4tdz