Setup documentation

Author: CodeDoctorDE

CONTRIBUTING.md

@@ -6,21 +6,21 @@ If you have any questions, please contact me at [contact@linwood.dev](mailto:con
 
 There is a matrix server for this project [here](https://linwood.dev/matrix) and a discord server [here](https://discord.linwood.dev).
 
-Please follow the [Code of Conduct](https://docs.qeck.linwood.dev/code-of-conduct).
+Please follow the [Code of Conduct](https://quokka.linwood.dev/code-of-conduct).
 
 ## Give feedback
 
 The best way to give feedback is to open an issue on GitHub.
 Please report any bug you find [here](https://github.com/LinwoodDev/Qeck/issues/new?assignees=CodeDoctorDE&labels=bug%2Ctriage&template=bug_report.yml&title=%5BBug%5D%3A+).
 
-If you have a feature that you would like to see added, please open an issue [here](https://github.com/LinwoodDev/Qeck/issues/new?assignees=CodeDoctorDE&labels=enhancement%2Ctriage&template=feature_request.yml&title=%5BFeature+request%5D%3A+).
+If you have a feature that you would like to see added, please open an issue [here](https://github.com/LinwoodDev/Quokka/issues/new?assignees=CodeDoctorDE&labels=enhancement%2Ctriage&template=feature_request.yml&title=%5BFeature+request%5D%3A+).
 
 ## Test nightly builds
 
 Nightly builds are not production ready and need to be tested.
 Please report any bugs in the github issues section.
 
-Read more about it [here](https://docs.qeck.linwood.dev/nightly).
+Read more about it [here](https://quokka.linwood.dev/nightly).
 
 ## Write documentation
 

FLUTTER_VERSION

@@ -1 +1 @@
-3.24.0
+3.24.1

README.md

@@ -4,14 +4,14 @@
 
 # Quokka
 
-> WIP: 🃏 Play games everywhere you like 🃏
+> WIP: 🃏 Powerful, customizable, cross-platform, opensource table sandbox game 🃏
 
-[![Latest release)](https://img.shields.io/github/v/release/LinwoodDev/Vulpine?color=A28DDB&style=for-the-badge&logo=github&logoColor=A28DDB)](https://github.com/LinwoodDev/Vulpine/releases)
-[![GitHub License badge](https://img.shields.io/github/license/LinwoodDev/Vulpine?color=A28DDB&style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxOTIiIGhlaWdodD0iMTkyIiBmaWxsPSIjZWJiNzMzIiB2aWV3Qm94PSIwIDAgMjU2IDI1NiI%2BPHJlY3Qgd2lkdGg9IjI1NiIgaGVpZ2h0PSIyNTYiIGZpbGw9Im5vbmUiPjwvcmVjdD48cmVjdCB4PSIzMiIgeT0iNDgiIHdpZHRoPSIxOTIiIGhlaWdodD0iMTYwIiByeD0iOCIgc3Ryb2tlLXdpZHRoPSIxNiIgc3Ryb2tlPSIjZWJiNzMzIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGZpbGw9Im5vbmUiPjwvcmVjdD48bGluZSB4MT0iNzYiIHkxPSI5NiIgeDI9IjE4MCIgeTI9Ijk2IiBmaWxsPSJub25lIiBzdHJva2U9IiNlYmI3MzMiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCIgc3Ryb2tlLXdpZHRoPSIxNiI%2BPC9saW5lPjxsaW5lIHgxPSI3NiIgeTE9IjEyOCIgeDI9IjE4MCIgeTI9IjEyOCIgZmlsbD0ibm9uZSIgc3Ryb2tlPSIjZWJiNzMzIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHN0cm9rZS13aWR0aD0iMTYiPjwvbGluZT48bGluZSB4MT0iNzYiIHkxPSIxNjAiIHgyPSIxODAiIHkyPSIxNjAiIGZpbGw9Im5vbmUiIHN0cm9rZT0iI2ViYjczMyIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiBzdHJva2Utd2lkdGg9IjE2Ij48L2xpbmU%2BPC9zdmc%2B)](https://github.com/LinwoodDev/Vulpine/blob/main/LICENSE)
-[![GitHub Repo stars](https://img.shields.io/github/stars/LinwoodDev/Vulpine?color=A28DDB&logo=github&logoColor=A28DDB&style=for-the-badge)](https://github.com/LinwoodDev/Vulpine)
+[![Latest release)](https://img.shields.io/github/v/release/LinwoodDev/Quokka?color=A28DDB&style=for-the-badge&logo=github&logoColor=A28DDB)](https://github.com/LinwoodDev/Quokka/releases)
+[![GitHub License badge](https://img.shields.io/github/license/LinwoodDev/Quokka?color=A28DDB&style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxOTIiIGhlaWdodD0iMTkyIiBmaWxsPSIjZWJiNzMzIiB2aWV3Qm94PSIwIDAgMjU2IDI1NiI%2BPHJlY3Qgd2lkdGg9IjI1NiIgaGVpZ2h0PSIyNTYiIGZpbGw9Im5vbmUiPjwvcmVjdD48cmVjdCB4PSIzMiIgeT0iNDgiIHdpZHRoPSIxOTIiIGhlaWdodD0iMTYwIiByeD0iOCIgc3Ryb2tlLXdpZHRoPSIxNiIgc3Ryb2tlPSIjZWJiNzMzIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGZpbGw9Im5vbmUiPjwvcmVjdD48bGluZSB4MT0iNzYiIHkxPSI5NiIgeDI9IjE4MCIgeTI9Ijk2IiBmaWxsPSJub25lIiBzdHJva2U9IiNlYmI3MzMiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCIgc3Ryb2tlLXdpZHRoPSIxNiI%2BPC9saW5lPjxsaW5lIHgxPSI3NiIgeTE9IjEyOCIgeDI9IjE4MCIgeTI9IjEyOCIgZmlsbD0ibm9uZSIgc3Ryb2tlPSIjZWJiNzMzIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHN0cm9rZS13aWR0aD0iMTYiPjwvbGluZT48bGluZSB4MT0iNzYiIHkxPSIxNjAiIHgyPSIxODAiIHkyPSIxNjAiIGZpbGw9Im5vbmUiIHN0cm9rZT0iI2ViYjczMyIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiBzdHJva2Utd2lkdGg9IjE2Ij48L2xpbmU%2BPC9zdmc%2B)](https://github.com/LinwoodDev/Quokka/blob/main/LICENSE)
+[![GitHub Repo stars](https://img.shields.io/github/stars/LinwoodDev/Quokka?color=A28DDB&logo=github&logoColor=A28DDB&style=for-the-badge)](https://github.com/LinwoodDev/Quokka)
 [![Matrix badge](https://img.shields.io/matrix/linwood:matrix.org?style=for-the-badge&color=A28DDB&logo=matrix&logoColor=A28DDB&label=Matrix)](https://linwood.dev/matrix)
 [![Discord badge](https://img.shields.io/discord/735424757142519848?style=for-the-badge&color=A28DDB&logo=discord&logoColor=A28DDB&label=Discord)](https://discord.linwood.dev)
-[![Download](https://img.shields.io/github/downloads/LinwoodDev/Vulpine/total?color=A28DDB&style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxOTIiIGhlaWdodD0iMTkyIiBmaWxsPSIjZWJiNzMzIiB2aWV3Qm94PSIwIDAgMjU2IDI1NiI+PHJlY3Qgd2lkdGg9IjI1NiIgaGVpZ2h0PSIyNTYiIGZpbGw9Im5vbmUiPjwvcmVjdD48cG9seWxpbmUgcG9pbnRzPSI4NiAxMTAuMDExIDEyOCAxNTIgMTcwIDExMC4wMTEiIGZpbGw9Im5vbmUiIHN0cm9rZT0iI2ViYjczMyIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiBzdHJva2Utd2lkdGg9IjE2Ij48L3BvbHlsaW5lPjxsaW5lIHgxPSIxMjgiIHkxPSI0MCIgeDI9IjEyOCIgeTI9IjE1MS45NzA1NyIgZmlsbD0ibm9uZSIgc3Ryb2tlPSIjZWJiNzMzIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHN0cm9rZS13aWR0aD0iMTYiPjwvbGluZT48cGF0aCBkPSJNMjE2LDE1MnY1NmE4LDgsMCwwLDEtOCw4SDQ4YTgsOCwwLDAsMS04LThWMTUyIiBmaWxsPSJub25lIiBzdHJva2U9IiNlYmI3MzMiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCIgc3Ryb2tlLXdpZHRoPSIxNiI+PC9wYXRoPjwvc3ZnPg==)](https://qeck.linwood.dev)
+[![Download](https://img.shields.io/github/downloads/LinwoodDev/Quokka/total?color=A28DDB&style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxOTIiIGhlaWdodD0iMTkyIiBmaWxsPSIjZWJiNzMzIiB2aWV3Qm94PSIwIDAgMjU2IDI1NiI+PHJlY3Qgd2lkdGg9IjI1NiIgaGVpZ2h0PSIyNTYiIGZpbGw9Im5vbmUiPjwvcmVjdD48cG9seWxpbmUgcG9pbnRzPSI4NiAxMTAuMDExIDEyOCAxNTIgMTcwIDExMC4wMTEiIGZpbGw9Im5vbmUiIHN0cm9rZT0iI2ViYjczMyIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiBzdHJva2Utd2lkdGg9IjE2Ij48L3BvbHlsaW5lPjxsaW5lIHgxPSIxMjgiIHkxPSI0MCIgeDI9IjEyOCIgeTI9IjE1MS45NzA1NyIgZmlsbD0ibm9uZSIgc3Ryb2tlPSIjZWJiNzMzIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHN0cm9rZS13aWR0aD0iMTYiPjwvbGluZT48cGF0aCBkPSJNMjE2LDE1MnY1NmE4LDgsMCwwLDEtOCw4SDQ4YTgsOCwwLDAsMS04LThWMTUyIiBmaWxsPSJub25lIiBzdHJva2U9IiNlYmI3MzMiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCIgc3Ryb2tlLXdpZHRoPSIxNiI+PC9wYXRoPjwvc3ZnPg==)](https://quokka.linwood.dev)
 </div>
 
 <p align="center">
@@ -30,12 +30,42 @@
 
 **Click [here](https://github.com/LinwoodDev/Quokka/discussions/26) to read about the concept and share your thoughts!**
 
+## Limitations of the preview
+
+* The protocol is not stable and will change
+  * This means you need to have the same version of the client and server
+* There is no server binary yet
+  * You need to run the client to host a server
+  * Will be added in 0.2
+* No rules are implemented yet
+  * You can only play without rules
+  * Will be added in 0.3
+* Missing error messages
+  * Some errors are not displayed
+* Packs won't be checked on connecting
+  * Make sure you have the same packs as the server
+
 ## Features
 
-* Play games with your friends or alone
-* No internet connection required to play together
-* Configure if you want to play with or without rules
-* Create custom cards, board and dices
-* Develop your custom rules with lua
-* Pack them all into a package and share it with your friends
-* Load the rules in the server and the client
+* **👥 Multiplayer:** Play games with your friends or alone
+* **🚫 No internet connection required:** to play, multiplayer also works offline
+* **🚩 Configurable:** Configure if you want to play with or without rules
+* **🎨 Customizable:** Create custom cards, board and dices
+* ~~**➕ Extensible:** Develop your custom rules with lua (Will be added in 0.3)~~
+* **📂 Share your packs:** Pack them all into a package and share it with your friends
+* **⚙️ Universal packs:** Load the rules in the server and the client
+* **📱 Works on every device:** The app is available for android, windows, linux, and in the web. You can use it on your phone, tablet, or computer.
+* **📚 FOSS:** The app is open source and free. You can contribute to the project and help to make it better.
+
+---
+
+## Contributing
+
+We are happy to see that you are interested in contributing to Butterfly.
+To get started, visit [the contributing guide](CONTRIBUTING.md).
+
+## License
+
+The code is open source and licensed under the [AGPL-3.0](./LICENSE) license.
+All images in `app/images/`, the core pack in `app/packs` and all images in `docs/` are licensed under the [CC-BY-4.0](./BRANDING_LICENSE) license.
+The files in `api` are licensed under the [Apache-2.0](./api/LICENSE) license instead of the AGPL-3.0 license to allow the use of the API without the need to open source the code (for example for extensions or other external services).

SECURITY.md

@@ -2,9 +2,9 @@
 
 ## Supported Versions
 
-| Version | Supported |                                                |
-| ------- | --------- | ---------------------------------------------- |
-| -       | :warning: | [Docs](https://qeck.linwood.dev/docs/v0/intro) |
+| Version | Supported |                                                  |
+| ------- | --------- | ------------------------------------------------ |
+| -       | :warning: | [Docs](https://quokka.linwood.dev/docs/v1/intro) |
 
 Currently there is no version released yet.
 Because of that, there is also no main branch.

app/android/fastlane/metadata/android/en-US/changelogs/default.txt

@@ -1 +1 @@
-Read more here: https://docs.qeck.linwood.dev/changelog
+Read more here: https://docs.quokka.linwood.dev/changelog

app/lib/pages/settings/general.dart

@@ -45,7 +45,7 @@ class _GeneralSettingsPageState extends State<GeneralSettingsPage> {
 
   Future<Meta> _fetchMeta() async {
     final response =
-        await http.get(Uri.parse('https://docs.qeck.linwood.dev/meta.json'));
+        await http.get(Uri.parse('https://docs.quokka.linwood.dev/meta.json'));
     return Meta.fromJson({...json.decode(response.body)});
   }
 

docs/astro.config.mjs

@@ -1,14 +1,28 @@
 import { defineConfig } from "astro/config";
 import starlight from "@astrojs/starlight";
+import react from "@astrojs/react";
 
 // https://astro.build/config
 export default defineConfig({
   integrations: [
     starlight({
-      title: "My Docs",
+      title: "Linwood Quokka",
+      customCss: ["./src/styles/custom.css"],
       social: {
         github: "https://github.com/withastro/starlight",
       },
+      social: {
+        mastodon: "https://floss.social/@linwood",
+        matrix: "https://linwood.dev/matrix",
+        discord: "https://linwood.dev/discord",
+        github: "https://github.com/LinwoodDev/Butterfly",
+      },
+      components: {
+        SocialIcons: "./src/components/CustomSocialIcons.astro",
+        Head: "./src/components/Head.astro",
+        Footer: "./src/components/Footer.astro",
+        ContentPanel: "./src/components/ContentPanel.astro",
+      },
       sidebar: [
         {
           label: "Guides",
@@ -23,5 +37,6 @@ export default defineConfig({
         },
       ],
     }),
+    react(),
   ],
 });

docs/package.json

@@ -10,11 +10,19 @@
     "astro": "astro"
   },
   "dependencies": {
-    "@astrojs/check": "^0.9.2",
+    "@astrojs/check": "^0.9.3",
+    "@astrojs/react": "^3.6.2",
     "@astrojs/starlight": "^0.26.1",
-    "astro": "^4.14.2",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "astro": "^4.14.3",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
     "sharp": "^0.33.5",
     "typescript": "^5.5.4"
   },
-  "packageManager": "pnpm@9.7.1"
+  "packageManager": "pnpm@9.7.1",
+  "devDependencies": {
+    "sass": "^1.77.8"
+  }
 }