Implemented ProzillaOS games + updated docs

Prozilla · Prozilla · commit 5ec6a2982769 · 2024-10-03T21:45:02.000+02:00
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -2,5 +2,6 @@
     "default": true,
 	"MD033": false,
 	"MD041": false,
-	"MD013": false
+	"MD013": false,
+	"MD024": false
 }
diff --git a/README.md b/README.md
@@ -63,35 +63,7 @@ For more information, refer to the [self-hosting guide](https://os.prozilla.dev/
 
 ## Packages
 
-### Libraries (public)
-
-These libraries are different modules of ProzillaOS that can be installed separately or via the bundle package `prozilla-os`. Each library has a `src/main.ts` entry file and is published to the npm registry.
-
-- [`prozilla-os`][prozilla-os]: A bundle containing the core packages and all standard applications of ProzillaOS
-- [`@prozilla-os/core`][core]: Core functionality, React components and hooks
-- [`@prozilla-os/skins`][skins]: Customizable skins for ProzillaOS
-- [`@prozilla-os/shared`][shared]: Shared functions and utilities
-
-#### Standard applications
-
-- [`@prozilla-os/file-explorer`][file-explorer]: File explorer app
-- [`@prozilla-os/terminal`][terminal]: Terminal/shell app
-- [`@prozilla-os/text-editor`][text-editor]: Text editor app
-- [`@prozilla-os/settings`][settings]: Settings app
-- [`@prozilla-os/media-viewer`][media-viewer]: Media viewer app
-- [`@prozilla-os/browser`][browser]: Browser app
-- [`@prozilla-os/calculator`][calculator]: Calculator app
-
-#### Non-standard applications
-
-- [`@prozilla-os/logic-sim`][logic-sim]: Logic simulator app
-
-### Sites (internal)
-
-These packages contains the source code of parts of the ProzillaOS website. They are published to GitHub pages.
-
-- [`@prozilla-os/demo`](./packages/demo/): Demo site
-- [`@prozilla-os/docs`](./packages/docs/): Documentation site
+You can find a list of all packages related to ProzillaOS in [packages/README.md](./packages/README.md).
 
 <!-- #endregion packages -->
 
@@ -104,13 +76,11 @@ These packages contains the source code of parts of the ProzillaOS website. They
 - [Discord][discord]
 - [Ko-fi][ko-fi]
 
-## Resources
-
-These resources can help you get started with ProzillaOS.
+### Resources
 
 - [Getting started guide](https://os.prozilla.dev/docs/guides/getting-started)
 - [Self-hosting guide](https://os.prozilla.dev/docs/guides/self-hosting)
-- [prozilla-os/ProzillaOS-boilerplate][boilerplate]: Boilerplate code for a React Vite app implementing ProzillaOS
+- [ProzillaOS boilerplate][boilerplate]
 
 ## License
 
@@ -125,14 +95,3 @@ ProzillaOS is [MIT licensed](./LICENSE).
 [boilerplate]: https://github.com/prozilla-os/ProzillaOS-boilerplate
 [prozilla]: https://prozilla.dev/
 [prozilla-os]: ./packages/prozilla-os/
-[core]: ./packages/core/
-[skins]: ./packages/skins/
-[shared]: ./packages/shared/
-[file-explorer]: ./packages/apps/file-explorer/
-[terminal]: ./packages/apps/terminal/
-[text-editor]: ./packages/apps/text-editor/
-[settings]: ./packages/apps/settings/
-[media-viewer]: ./packages/apps/media-viewer/
-[browser]: ./packages/apps/browser/
-[calculator]: ./packages/apps/calculator/
-[logic-sim]: ./packages/apps/logic-sim/
diff --git a/packages/README.md b/packages/README.md
@@ -1,14 +1,23 @@
 # Packages
 
+This is an overview of all packages related to ProzillaOS.
+
+<!-- #region libraries -->
+
 ## Libraries (public)
 
+These libraries are different modules of ProzillaOS that can be installed separately or via the bundle package `prozilla-os`. Each library is published to the npm registry.
+
 - [`prozilla-os`](./prozilla-os/): A bundle containing the core packages and all standard applications of ProzillaOS
 - [`@prozilla-os/core`](./core/): Core functionality, React components and hooks
 - [`@prozilla-os/skins`](./skins/): Customizable skins for ProzillaOS
 - [`@prozilla-os/shared`](./shared/): Shared functions and utilities
+- [`@prozilla-os/dev-tools`](./dev-tools/): Tools for development of ProzillaOS packages
 
 ### Standard applications
 
+These applications are included in the `prozilla-os` bundle.
+
 - [`@prozilla-os/file-explorer`](./apps/file-explorer/): File explorer app
 - [`@prozilla-os/terminal`](./apps/terminal/): Terminal/shell app
 - [`@prozilla-os/text-editor`](./apps/text-editor/): Text editor app
@@ -21,7 +30,33 @@
 
 - [`@prozilla-os/logic-sim`](./apps/logic-sim/): Logic simulator app
 
-## Sites (internal)
+<!-- #endregion libraries -->
+
+<!-- #region sites -->
+
+## Sites (private)
+
+These packages contains the source code of parts of the ProzillaOS website. They are published to GitHub pages.
+
+- [`@prozilla-os/demo`](./demo/): Demo site - **[os.prozilla.dev](https://os.prozilla.dev/)**
+- [`@prozilla-os/docs`](./docs/): Documentation site - **[os.prozilla.dev/docs](https://os.prozilla.dev/docs/)**
+
+<!-- #endregion sites -->
+
+<!-- #region external -->
+
+## External applications
+
+These applications are related to ProzillaOS and used in the website, but their source code is hosted in a separate repository on GitHub.
+
+- [`@prozilla-os/minesweeper`][minesweeper]: Minesweeper clone
+- [`@prozilla-os/wordle`][wordle]: Wordle clone
+- [`@prozilla-os/ball-maze`][ball-maze]: 3D wooden ball maze game
+- [`@prozilla-os/bliss-radio`][bliss-radio]: Radio app
+
+[minesweeper]: https://github.com/prozilla-os/ProzillaOS-games/blob/main/packages/games/minesweeper
+[wordle]: https://github.com/prozilla-os/ProzillaOS-games/blob/main/packages/games/wordle
+[ball-maze]: https://github.com/prozilla-os/ProzillaOS-games/blob/main/packages/games/ball-maze
+[bliss-radio]: https://github.com/prozilla-os/Bliss-radio-app
 
-- [`@prozilla-os/demo`](./demo/): Demo site
-- [`@prozilla-os/docs`](./docs/): Documentation site
+<!-- #endregion external -->
diff --git a/packages/demo/package.json b/packages/demo/package.json
@@ -26,9 +26,12 @@
 		"@fortawesome/fontawesome-svg-core": "^6.5.2",
 		"@fortawesome/free-solid-svg-icons": "^6.5.2",
 		"@fortawesome/react-fontawesome": "^0.2.2",
+		"@prozilla-os/ball-maze": "^1.0.2",
 		"@prozilla-os/bliss-radio": "^1.0.6",
 		"@prozilla-os/logic-sim": "workspace:*",
+		"@prozilla-os/minesweeper": "^1.0.2",
 		"@prozilla-os/skins": "workspace:*",
+		"@prozilla-os/wordle": "^1.0.2",
 		"prozilla-os": "workspace:*",
 		"react": "^18.3.1",
 		"react-dom": "^18.3.1",
diff --git a/packages/demo/src/apps/ball-maze.ts b/packages/demo/src/apps/ball-maze.ts
diff --git a/packages/demo/src/apps/minesweeper.ts b/packages/demo/src/apps/minesweeper.ts
diff --git a/packages/demo/src/apps/wordle.ts b/packages/demo/src/apps/wordle.ts
diff --git a/packages/demo/src/config/apps.config.ts b/packages/demo/src/config/apps.config.ts
@@ -1,8 +1,8 @@
 import { AppsConfig, browser, calculator, fileExplorer, mediaViewer, settings, terminal, textEditor } from "prozilla-os";
 import { NAME } from "./branding.config";
-import { wordle } from "../apps/wordle";
-import { ballMaze } from "../apps/ball-maze";
-import { minesweeper } from "../apps/minesweeper";
+import { wordle } from "@prozilla-os/wordle";
+import { ballMaze } from "@prozilla-os/ball-maze";
+import { minesweeper } from "@prozilla-os/minesweeper";
 import { logicSim } from "@prozilla-os/logic-sim";
 import { blissRadio } from "@prozilla-os/bliss-radio";
 
diff --git a/packages/docs/.vitepress/theme/style.css b/packages/docs/.vitepress/theme/style.css
@@ -388,4 +388,8 @@ li > p {
 .vp-doc img {
 	border-radius: 8px;
 	margin: 16px 0;
+}
+
+.vp-doc p {
+	line-height: 1.5;
 }
diff --git a/packages/docs/src/guides/custom-app.md b/packages/docs/src/guides/custom-app.md
@@ -4,4 +4,27 @@ outline: deep
 
 # Making a custom app
 
-Coming soon!
+There are two main ways to create custom applications for ProzillaOS:
+
+1. [Internal app](#internal-app)
+2. [External app](#external-app)
+
+An internal app lives inside the same repository as the OS itself. An external app has a separate repository and must therefore also be published to a package directory, like npm, before being usable in a ProzillaOS project. The internal app approach is the simplest one and easiest one to set up, while the other approach is a bit more technical.
+
+## 1. Internal app {#internal-app}
+
+### Prerequisites
+
+This guide assumes you have already set up a basic project that implements ProzillaOS. You can use to [getting started guide](/guides/getting-started) to set up a project with ProzillaOS.
+
+### Setup
+
+Create a new folder where you can put the source code of your custom ProzillaOS application.
+
+## 2. External app {#external-app}
+
+### Prerequisites
+
+This guide assumes you have already set up a basic React project with TypeScript. To learn more about how to set up a React project, check out the official [React documentation](https://react.dev/learn/start-a-new-react-project). The React documentation also has a guide on [how to start using TypeScript in your React project](https://react.dev/learn/typescript).
+
+### Setup
diff --git a/packages/docs/src/reference/dev-tools/index.md b/packages/docs/src/reference/dev-tools/index.md
@@ -0,0 +1,7 @@
+---
+outline: deep
+---
+
+# @prozilla-os/dev-tools
+
+<!--@include: ../../../../dev-tools/README.md{13,}-->
diff --git a/packages/docs/src/reference/packages.md b/packages/docs/src/reference/packages.md
@@ -4,8 +4,12 @@ outline: deep
 
 # Packages
 
-These packages are different modules of ProzillaOS that can be installed separately or via the bundle package `prozilla-os`.
+This is an overview of all packages related to ProzillaOS.
 
-### Libraries
+## Libraries
 
-<!--@include: ../../../README.md{4,23}-->
+<!--@include: ../../../README.md#libraries{3,}-->
+
+### External applications
+
+<!--@include: ../../../README.md#external{3,}-->
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,6 @@`
`2`	`2`	`"default": true,`
`3`	`3`	`"MD033": false,`
`4`	`4`	`"MD041": false,`
`5`		`- "MD013": false`
	`5`	`+ "MD013": false,`
	`6`	`+ "MD024": false`
`6`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -388,4 +388,8 @@ li > p {`
`388`	`388`	`.vp-doc img {`
`389`	`389`	`border-radius: 8px;`
`390`	`390`	`margin: 16px 0;`
	`391`	`+}`
	`392`	`+`
	`393`	`+.vp-doc p {`
	`394`	`+ line-height: 1.5;`
`391`	`395`	`}`