Bug meat & modifications

README.md

@@ -1,3 +1,16 @@
 # Mosaic Modding Documentation
 
-currently just a proof of concept
+### How to get this running on your device
+1. Fork & clone the repo
+2. Run `npm install`
+3. Run `npm start` to start the local dev instance
+
+### Contribute
+- If you're a Team Member only work on the dev branch and open a PR to main, when you want to publish a new version
+- If you're an external Contributor, simply fork the repo add the feature and open a PR to the **dev** branch.
+
+### Publish a new version
+1. Open a PR from dev to main.
+2. Wait for the "Test Deployment" action to complete
+3. If that action was successful, merge the PR.
+4. This will trigger the actual Deployment action

docusaurus.config.ts

@@ -76,7 +76,7 @@ const config: Config = {
               routeBasePath: "cosmetics",
               sidebarPath: require.resolve(`./sidebar/cosmetics.ts`),
           },
-      ],
+      ]/*, TODO readd once needed
       ["@docusaurus/plugin-content-docs",
           {
               id: "plaster",
@@ -93,6 +93,7 @@ const config: Config = {
               sidebarPath: require.resolve(`./sidebar/tessera.ts`),
           },
       ]
+      */
   ],
 
   themeConfig: {
@@ -119,7 +120,7 @@ const config: Config = {
           position: 'left',
           docsPluginId: 'paintersinc',
           label: 'Painter\'s Inc',
-        },
+        }/*, TODO readd once needed
         {
           type: 'docSidebar',
           sidebarId: 'plasterSidebar',
@@ -133,7 +134,7 @@ const config: Config = {
           position: 'left',
           docsPluginId: 'tessera',
           label: 'Tessera',
-        },
+        },*/
       ],
     },
     footer: {
@@ -158,7 +159,8 @@ const config: Config = {
                   {
                       label: 'Cosmetics',
                       to: '/cosmetics/about',
-                  },
+                  }
+                  /*, TODO readd once needed
                   {
                       label: 'Tessera',
                       to: '/tessera/about',
@@ -167,6 +169,7 @@ const config: Config = {
                       label: 'Plaster',
                       to: '/plaster/about',
                   },
+                   */
               ],
           },
         {

src/components/EntityAttributes.tsx

@@ -1,5 +1,6 @@
 import useBaseUrl from "@docusaurus/useBaseUrl";
 import React from "react";
+import Hearts from "@site/src/components/Hearts";
 
 export default function EntityAttributes(props: any) {
     return (
@@ -28,10 +29,12 @@ export default function EntityAttributes(props: any) {
                             <div className={"attack-card"}>
                                 <div className={"attack-header"}>
                                     <h4>{item.type}</h4>
-                                    <img
-                                        src={useBaseUrl("/img/" + item.weapontype + ".png")}
-                                        alt={item.weapontype + " icon"}
-                                    />
+                                    {item.weapontype !== null && item.weapontype !== undefined && (
+                                        <img
+                                            src={useBaseUrl("/img/" + item.weapontype + ".png")}
+                                            alt={item.weapontype + " icon"}
+                                        />
+                                    )}
                                 </div>
                                 <ul>
                                     <li>Easy:<Hearts amount={item.easy}/></li>
@@ -56,38 +59,6 @@ export default function EntityAttributes(props: any) {
     );
 }
 
-function calculateHearts(count: number) {
-    const full = Math.floor(count / 2);
-    const half = count % 2;
-    return { full, half };
-}
-
-export function Hearts(props: any) {
-    const fullImage = useBaseUrl("/img/full_heart.png");
-    const halfImage = useBaseUrl("/img/half_heart.png");
-    let heartAmount = calculateHearts(props.amount);
-    return (
-        <div className={"hearts"}>
-            {props.amount} (
-            {Array.from({ length: heartAmount.full }).map((_, index) => (
-                <img
-                    key={index}
-                    src={fullImage}
-                    alt={"Full Heart icon"}
-                />
-            ))}
-            {Array.from({ length: heartAmount.half }).map((_, index) => (
-                <img
-                    key={index}
-                    src={halfImage}
-                    alt={"Half Heart icon"}
-                />
-            ))}
-            )
-        </div>
-    );
-}
-
 export enum MobBehavior {
     Passive = "Passive",
     Neutral = "Neutral",
@@ -96,7 +67,7 @@ export enum MobBehavior {
 
 interface Damage {
     type: WeaponType;
-    weapontype: string;
+    weapontype: string | null;
     easy: number | string;
     normal: number | string;
     hard: number | string;

src/components/FoodShowcase.tsx

@@ -0,0 +1,73 @@
+import useBaseUrl from "@docusaurus/useBaseUrl";
+import React from "react";
+import Hunger from "@site/src/components/Hunger";
+import Hearts from "@site/src/components/Hearts";
+
+export default function ShowcaseBlock(props: any) {
+    return (
+        <div style={{ display: 'flex', gap: '1rem', alignItems: 'flex-start' }}>
+            <div className="item-card">
+                {props.title && (
+                    <div className="item-card__header">
+                        <h3 className="item-card__title">{props.title}</h3>
+                    </div>
+                )}
+                <div className="item-card__content">
+                    <img
+                        src={useBaseUrl('/' + props.image)}
+                        alt={props.image}
+                        className="item-card__image"
+                    />
+                </div>
+                {props.nutrition && (
+                    <div className="item-attribute-card__content">
+                        <b>Nutrition:&nbsp;</b><Hunger amount={props.nutrition}/>
+                    </div>
+                )}
+                {props.saturation && (
+                    <div className="item-attribute-card__content">
+                        <b>Saturation:&nbsp;</b><Hunger amount={props.saturation}/>
+                    </div>
+                )}
+                {props.always === true && (
+                    <div className="item-attribute-card__content">
+                        Can always be eaten.
+                    </div>
+                )}
+                {props.dogFood === true && (
+                    <div className="item-attribute-card__content">
+                        Can be fed to dogs.
+                    </div>
+                )}
+                {props.effects && (
+                    <div className="item-attribute-card__content">
+                        <div>
+                            <b>Effects:</b> {props.effects.map((item: Effect) =>
+                            <div>
+                                <h5>{item.name}</h5>
+                                <ul>
+                                    <li>Chance to apply: {item.probability}%</li>
+                                    <li>Duration: {item.duration}</li>
+                                </ul>
+                            </div>
+                        )}
+                        </div>
+                    </div>
+                )}
+            </div>
+            <div>
+                {props.children && (
+                    <div>
+                        {props.children}
+                    </div>
+                )}
+            </div>
+        </div>
+    );
+}
+
+export interface Effect {
+    name: string,
+    probability: number,
+    duration: string
+}

src/components/Hearts.tsx

@@ -0,0 +1,29 @@
+import useBaseUrl from "@docusaurus/useBaseUrl";
+import React from "react";
+import calculateHalfFull from "@site/src/util/CalculateHalfFull";
+
+export default function Hearts(props: any) {
+    const fullImage = useBaseUrl("/img/full_heart.png");
+    const halfImage = useBaseUrl("/img/half_heart.png");
+    let heartAmount = calculateHalfFull(props.amount);
+    return (
+        <div className={"mc_icons"}>
+            {props.amount} (
+            {Array.from({ length: heartAmount.full }).map((_, index) => (
+                <img
+                    key={index}
+                    src={fullImage}
+                    alt={"Full Heart icon"}
+                />
+            ))}
+            {Array.from({ length: heartAmount.half }).map((_, index) => (
+                <img
+                    key={index}
+                    src={halfImage}
+                    alt={"Half Heart icon"}
+                />
+            ))}
+            )
+        </div>
+    );
+}

src/components/Hunger.tsx

@@ -0,0 +1,29 @@
+import useBaseUrl from "@docusaurus/useBaseUrl";
+import React from "react";
+import calculateHalfFull from "@site/src/util/CalculateHalfFull";
+
+export default function Hunger(props: any) {
+    const fullImage = useBaseUrl("/img/full_hunger.png");
+    const halfImage = useBaseUrl("/img/half_hunger.png");
+    let hungerAmount = calculateHalfFull(props.amount);
+    return (
+        <div className={"mc_icons"}>
+            {props.amount} (
+            {Array.from({ length: hungerAmount.full }).map((_, index) => (
+                <img
+                    key={index}
+                    src={fullImage}
+                    alt={"Full Hunger icon"}
+                />
+            ))}
+            {Array.from({ length: hungerAmount.half }).map((_, index) => (
+                <img
+                    key={index}
+                    src={halfImage}
+                    alt={"Half Hunger icon"}
+                />
+            ))}
+            )
+        </div>
+    );
+}

src/components/ShowcaseBlock.tsx

@@ -1,7 +1,6 @@
 import React from "react";
 import useBaseUrl from '@docusaurus/useBaseUrl';
 
-
 export default function ShowcaseBlock(props: any) {
     return (
         <div style={{ display: 'flex', gap: '1rem', alignItems: 'flex-start' }}>
@@ -14,7 +13,7 @@ export default function ShowcaseBlock(props: any) {
                 <div className="item-card__content">
                     <img
                         src={useBaseUrl('/' + props.image)}
-                        alt={props.title}
+                        alt={props.image}
                         className="item-card__image"
                     />
                 </div>

src/css/custom.css

@@ -101,15 +101,15 @@ a.no-underline {
     border-bottom: 1px solid var(--box-outline);
 }
 
-.hearts {
+.mc_icons {
     display: flex;
     align-items: center;
     gap: 1px;
     flex-wrap: wrap;
     max-width: 100%;
 }
 
-.hearts img {
+.mc_icons img {
     width: 11px;
     height: 11px;
 }

src/pages/index-content.mdx

@@ -37,6 +37,7 @@ import Card from "../components/Card.tsx";
                 linkTitle="Learn More"
             />
         </div>
+        {/* TODO readd once needed
         <div className="col category">
             <Card
                 title="Tessera"
@@ -53,6 +54,7 @@ import Card from "../components/Card.tsx";
                 linkTitle="Learn More"
             />
         </div>
+        */}
     </div>
 </div>
 

src/pages/index.tsx

@@ -20,7 +20,7 @@ export default function Home(): ReactNode {
   return (
     <Layout
       title={`${siteConfig.title}`}
-      description="Description will go into a meta tag in <head />">
+      description="The offical Wiki for the Mosaic Modding Team">
       <HomepageHeader/>
       <div className={clsx(styles.introduction)}>
           <IndexContent/>

src/util/CalculateHalfFull.ts

@@ -0,0 +1,5 @@
+export default function calculateHalfFull(count: number) {
+    const full = Math.floor(count / 2);
+    const half = count % 2;
+    return { full, half };
+}

sullysmod/about.mdx

@@ -1,5 +1,6 @@
 ---
 title: Sully's Mod - About
+sidebar_position: 0
 ---
 
 Sully’s Mod started out a few years ago when I decided to try and make a minecraft mod. I couldn’t think of a name and called it the first name that came to my head as a placeholder “Sully”, the name stuck and now people think my name is actually Sully.
@@ -8,4 +9,4 @@ I decided to completely revamp the mod, completely dumping the MCreator version
 With each feature I try to think it out as well as I can, making sure the feature is well-balanced, feels fun to play with and overall just feels like something new. It tries it’s best to feel like a Minecraft update full of random features.
 The mod is planned to have features for every player, explorers, builders and redstone engineers.
 
-All the features are put into different categories that can be toggled on or off. The wiki uses these categories as an orientation.
+The features of this mod are sorted into different categories. This wiki is structured based on these categories.

sullysmod/amber.mdx

@@ -1,5 +1,6 @@
 ---
 title: Amber
+sidebar_position: 7
 ---
 import ShowcaseBlock from "../src/components/ShowcaseBlock";
 
@@ -19,6 +20,8 @@ In melting state any entity slowly sinks into the block. The rest of the block's
 Regular **Amber** also slows down entities, but when the entity is fully covered, it will freeze the entity inside it and will stop melting.
 Breaking any of amber blocks that are responsible for keeping the entity frozen, will cause the other responsible blocks to break as well and will free the entity.
 
+[Showcase: Freezing Mobs in Amber](https://youtu.be/BZxX0lL_ZLc)
+
 ## Producing Amber
 Since breaking Amber blocks drops **Rough Amber**, there has to be a different way to get more of the regular transparent **Amber**.
 To do that you can place an amber block above a cauldron and set it in melting state. Then it will start sweating amber drops, that slowly fill the cauldron.

sullysmod/artifacts/_category_.json

@@ -1,3 +1,4 @@
 {
-  "label": "Artifacts"
+  "label": "Artifacts",
+  "position": 8
 }

sullysmod/artifacts/ancient_skulls.mdx

@@ -0,0 +1,3 @@
+---
+title: Ancient Skulls
+---