diff --git a/README.md b/README.md index 5899775..9ba14d5 100644 --- a/README.md +++ b/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 diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 8b419d2..9210af0 100644 --- a/docusaurus.config.ts +++ b/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', }, + */ ], }, { diff --git a/src/components/EntityAttributes.tsx b/src/components/EntityAttributes.tsx index 9945018..be74dc8 100644 --- a/src/components/EntityAttributes.tsx +++ b/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) {

{item.type}

- {item.weapontype + {item.weapontype !== null && item.weapontype !== undefined && ( + {item.weapontype + )}
diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 4b463f2..3436fd1 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -20,7 +20,7 @@ export default function Home(): ReactNode { return ( + description="The offical Wiki for the Mosaic Modding Team">
diff --git a/src/util/CalculateHalfFull.ts b/src/util/CalculateHalfFull.ts new file mode 100644 index 0000000..b9b4f3f --- /dev/null +++ b/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 }; +} \ No newline at end of file diff --git a/static/img/bug_meat.png b/static/img/bug_meat.png new file mode 100644 index 0000000..8d9ac5c Binary files /dev/null and b/static/img/bug_meat.png differ diff --git a/static/img/builtin_retextures.png b/static/img/builtin_retextures.png new file mode 100644 index 0000000..d4427ac Binary files /dev/null and b/static/img/builtin_retextures.png differ diff --git a/static/img/cooked_bug_meat.png b/static/img/cooked_bug_meat.png new file mode 100644 index 0000000..1a0d1ce Binary files /dev/null and b/static/img/cooked_bug_meat.png differ diff --git a/static/img/full_hunger.png b/static/img/full_hunger.png new file mode 100644 index 0000000..c7cb18f Binary files /dev/null and b/static/img/full_hunger.png differ diff --git a/static/img/half_hunger.png b/static/img/half_hunger.png new file mode 100644 index 0000000..893d889 Binary files /dev/null and b/static/img/half_hunger.png differ diff --git a/static/img/jungle_spider.png b/static/img/jungle_spider.png new file mode 100644 index 0000000..99b012a Binary files /dev/null and b/static/img/jungle_spider.png differ diff --git a/static/img/lanternfish.png b/static/img/lanternfish.png new file mode 100644 index 0000000..ddc1b82 Binary files /dev/null and b/static/img/lanternfish.png differ diff --git a/static/img/mauled.gif b/static/img/mauled.gif new file mode 100644 index 0000000..bcdb890 Binary files /dev/null and b/static/img/mauled.gif differ diff --git a/static/img/mauled.png b/static/img/mauled.png deleted file mode 100644 index e2e23e4..0000000 Binary files a/static/img/mauled.png and /dev/null differ diff --git a/static/img/piranha.png b/static/img/piranha.png new file mode 100644 index 0000000..972343c Binary files /dev/null and b/static/img/piranha.png differ diff --git a/static/img/venom_vials.gif b/static/img/venom_vials.gif index 3882fb6..1b12291 100644 Binary files a/static/img/venom_vials.gif and b/static/img/venom_vials.gif differ diff --git a/sullysmod/about.mdx b/sullysmod/about.mdx index 2da2174..82d90a0 100644 --- a/sullysmod/about.mdx +++ b/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. \ No newline at end of file +The features of this mod are sorted into different categories. This wiki is structured based on these categories. \ No newline at end of file diff --git a/sullysmod/amber.mdx b/sullysmod/amber.mdx index e6f3696..233e569 100644 --- a/sullysmod/amber.mdx +++ b/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. diff --git a/sullysmod/amber/_category_.json b/sullysmod/amber/_category_.json deleted file mode 100644 index 27c09ab..0000000 --- a/sullysmod/amber/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Amber" -} \ No newline at end of file diff --git a/sullysmod/artifacts/_category_.json b/sullysmod/artifacts/_category_.json index 12bb486..d8465cf 100644 --- a/sullysmod/artifacts/_category_.json +++ b/sullysmod/artifacts/_category_.json @@ -1,3 +1,4 @@ { - "label": "Artifacts" + "label": "Artifacts", + "position": 8 } \ No newline at end of file diff --git a/sullysmod/artifacts/ancient_skulls.mdx b/sullysmod/artifacts/ancient_skulls.mdx new file mode 100644 index 0000000..83eae4a --- /dev/null +++ b/sullysmod/artifacts/ancient_skulls.mdx @@ -0,0 +1,3 @@ +--- +title: Ancient Skulls +--- \ No newline at end of file diff --git a/sullysmod/artifacts/index.mdx b/sullysmod/artifacts/index.mdx new file mode 100644 index 0000000..dc6184d --- /dev/null +++ b/sullysmod/artifacts/index.mdx @@ -0,0 +1,4 @@ +--- +title: Artifacts +sidebar_position: 1 +--- \ No newline at end of file diff --git a/sullysmod/artifacts/overworld.mdx b/sullysmod/artifacts/overworld.mdx deleted file mode 100644 index e69de29..0000000 diff --git a/sullysmod/bouldering_zombie.mdx b/sullysmod/bouldering_zombie.mdx new file mode 100644 index 0000000..2255d74 --- /dev/null +++ b/sullysmod/bouldering_zombie.mdx @@ -0,0 +1,48 @@ +--- +title: Bouldering Zombie +sidebar_position: 1 +--- +import ShowcaseBlock from "../src/components/ShowcaseBlock"; +import EntityAttributes, {MobBehavior, WeaponType} from "../src/components/EntityAttributes"; +import SpawnConfig, {Dimension} from "../src/components/SpawnConfig"; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +export const unarmed = { + type: WeaponType.Unarmed , + easy: 3, + normal: 5, + hard: 7 +} + +export const spawnRules = [ + "Only in deepslate levels", + "In all biomes besides the Deep Dark", + "Gets more common the further you go down", + "Note: By default this zombie replaces every vanilla zombie in deepslate layers. This can be changed in the Config!" +] + + + + + + + + + + + + + +The **Bouldering Zombie** is a new Zombie variant that is home to the deepslate layers of the world and can climb.
+It is taller than a regular Zombie and deals more damage.
+However, the **Bouldering Zombie** is very sensitive to _fire_, meaning that it will deal `1.5` times as much damage. \ No newline at end of file diff --git a/sullysmod/bouldering_zombie/_category_.json b/sullysmod/bouldering_zombie/_category_.json deleted file mode 100644 index 4d4d548..0000000 --- a/sullysmod/bouldering_zombie/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Bouldering Zombie" -} \ No newline at end of file diff --git a/sullysmod/bouldering_zombie/bouldering_zombie.mdx b/sullysmod/bouldering_zombie/bouldering_zombie.mdx deleted file mode 100644 index e69de29..0000000 diff --git a/sullysmod/bug_meat.mdx b/sullysmod/bug_meat.mdx new file mode 100644 index 0000000..160577d --- /dev/null +++ b/sullysmod/bug_meat.mdx @@ -0,0 +1,44 @@ +--- +title: Bug Meat +sidebar_position: 14 +--- +import FoodShowcase from "../src/components/FoodShowcase"; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +export const hunger = { + name: "Hunger", + probability: 100, + duration: "30 sec" +} + +export const nausea = { + name: "Nausea", + probability: 100, + duration: "30 sec" +} + +export const haste = { + name: "Haste", + probability: 100, + duration: "30 sec" +} + + + + + + + + + diff --git a/sullysmod/bug_meat/_category_.json b/sullysmod/bug_meat/_category_.json deleted file mode 100644 index 30ecfb6..0000000 --- a/sullysmod/bug_meat/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Bug Meat" -} \ No newline at end of file diff --git a/sullysmod/bug_meat/bug_meat.mdx b/sullysmod/bug_meat/bug_meat.mdx deleted file mode 100644 index e69de29..0000000 diff --git a/sullysmod/builtin_resourcepacks.mdx b/sullysmod/builtin_resourcepacks.mdx new file mode 100644 index 0000000..4647e67 --- /dev/null +++ b/sullysmod/builtin_resourcepacks.mdx @@ -0,0 +1,22 @@ +--- +title: Builtin Resource Packs +sidebar_position: 17 +--- +import ShowcaseBlock from "../src/components/ShowcaseBlock"; + +Builtin Resource Packs are included in the mod and can be activated when the mod is installed. + +## Mob Retextures +This Pack updates a few outdated looking mobs to fit better with Sully's Mod. +The mobs currently included are: +- Zombie +- Drowned +- Husk +- Cave Spider +- Skeleton Horse + + + +## Programmer Art Pack +This pack adds programmer art textures for Sully's Mod.
+This pack is currently work in progress and is not yet included in the mod. \ No newline at end of file diff --git a/sullysmod/copper_buttons.mdx b/sullysmod/copper_buttons.mdx index a87546b..3cc2afd 100644 --- a/sullysmod/copper_buttons.mdx +++ b/sullysmod/copper_buttons.mdx @@ -1,5 +1,6 @@ --- title: Copper Buttons +sidebar_position: 9 --- import ShowcaseBlock from "../src/components/ShowcaseBlock"; diff --git a/sullysmod/gem_lanterns.mdx b/sullysmod/gem_lanterns.mdx index 95cbccc..8fd66b4 100644 --- a/sullysmod/gem_lanterns.mdx +++ b/sullysmod/gem_lanterns.mdx @@ -1,5 +1,6 @@ --- title: Gem Lanterns +sidebar_position: 10 --- import ShowcaseBlock from "../src/components/ShowcaseBlock"; diff --git a/sullysmod/grindstone_polishing/_category_.json b/sullysmod/grindstone_polishing/_category_.json deleted file mode 100644 index 5bc53b1..0000000 --- a/sullysmod/grindstone_polishing/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Grindstone Polishing" -} \ No newline at end of file diff --git a/sullysmod/item_stand.mdx b/sullysmod/item_stand.mdx new file mode 100644 index 0000000..822c383 --- /dev/null +++ b/sullysmod/item_stand.mdx @@ -0,0 +1,4 @@ +--- +title: Item Stand +sidebar_position: 11 +--- \ No newline at end of file diff --git a/sullysmod/item_stand/_category_.json b/sullysmod/item_stand/_category_.json deleted file mode 100644 index 21ce7bb..0000000 --- a/sullysmod/item_stand/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Item Stand" -} \ No newline at end of file diff --git a/sullysmod/item_stand/item_stand.mdx b/sullysmod/item_stand/item_stand.mdx deleted file mode 100644 index e69de29..0000000 diff --git a/sullysmod/jade/_category_.json b/sullysmod/jade/_category_.json index 698ccbc..be13206 100644 --- a/sullysmod/jade/_category_.json +++ b/sullysmod/jade/_category_.json @@ -1,3 +1,4 @@ { - "label": "Jade" + "label": "Jade", + "position": 12 } \ No newline at end of file diff --git a/sullysmod/jade/grindstone_polishing.mdx b/sullysmod/jade/grindstone_polishing.mdx new file mode 100644 index 0000000..03d56fb --- /dev/null +++ b/sullysmod/jade/grindstone_polishing.mdx @@ -0,0 +1,3 @@ +--- +title: Grindstone Polishing +--- \ No newline at end of file diff --git a/sullysmod/jade/index.mdx b/sullysmod/jade/index.mdx new file mode 100644 index 0000000..6a59245 --- /dev/null +++ b/sullysmod/jade/index.mdx @@ -0,0 +1,4 @@ +--- +title: Jade Ore +sidebar_position: 1 +--- \ No newline at end of file diff --git a/sullysmod/jungle_spider.mdx b/sullysmod/jungle_spider.mdx new file mode 100644 index 0000000..8e1ceda --- /dev/null +++ b/sullysmod/jungle_spider.mdx @@ -0,0 +1,59 @@ +--- +title: Jungle Spider +sidebar_position: 2 +--- +import ShowcaseBlock from "../src/components/ShowcaseBlock"; +import EntityAttributes, {MobBehavior, WeaponType} from "../src/components/EntityAttributes"; +import SpawnConfig, {Dimension} from "../src/components/SpawnConfig"; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +export const unarmed = { + type: WeaponType.Unarmed , + easy: 2, + normal: 2, + hard: 3 +} + +export const spawnRules = [ + "Can spawn in any Jungle Biome" +] + + + + + + + + + + + + + +Each **Jungle Spider** has two venoms, one random _beneficial_ effect and one random _harmful_ effect.
+When a **Jungle Spider** attacks the player, it will give the player these effects. +The two colours on the **Jungle Spider's** back can help indicate the effects of the venom. + +The effect duration depends on the game's difficulty.
+ +| Difficulty | Duration | +|------------|----------| +| Easy | 5 sec | +| Normal | 10 sec | +| Hard | 15 sec | + +## Glass Vial + + You can craft a **Glass Vial**, which you can use to collect the **Jungle Spider's** venom.
+ When drinking, both effects will be applied. + diff --git a/sullysmod/jungle_spider/_category_.json b/sullysmod/jungle_spider/_category_.json deleted file mode 100644 index 6a364f1..0000000 --- a/sullysmod/jungle_spider/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Jungle Spider" -} \ No newline at end of file diff --git a/sullysmod/lanternfish.mdx b/sullysmod/lanternfish.mdx new file mode 100644 index 0000000..605d23e --- /dev/null +++ b/sullysmod/lanternfish.mdx @@ -0,0 +1,39 @@ +--- +title: Lanternfish +sidebar_position: 3 +--- +import ShowcaseBlock from "../src/components/ShowcaseBlock"; +import EntityAttributes, {MobBehavior, WeaponType} from "../src/components/EntityAttributes"; +import SpawnConfig, {Dimension} from "../src/components/SpawnConfig"; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +export const spawnRules = [ + "Can only spawn below y=16", + "Can only spawn if the light level at the spawning position is 0", + "Can spawn in all biomes except Lush Caves", + "Can only spawn in water" +] + + + + + + + + + + + + + +The Lanternfish is a new Mob that tries to avoid light and glows. When the Lanternfish is hurt it will stop glowing for a few seconds.
+On death the Lanternfish drops `Raw Lanternfish` and has a `0.05` chance of dropping Bonemeal. \ No newline at end of file diff --git a/sullysmod/lanternfish/_category_.json b/sullysmod/lanternfish/_category_.json deleted file mode 100644 index 6ff5e25..0000000 --- a/sullysmod/lanternfish/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Lanternfish" -} \ No newline at end of file diff --git a/sullysmod/lanternfish/lanternfish.mdx b/sullysmod/lanternfish/lanternfish.mdx deleted file mode 100644 index e69de29..0000000 diff --git a/sullysmod/mauled.mdx b/sullysmod/mauled.mdx index 8d9a01b..d188a14 100644 --- a/sullysmod/mauled.mdx +++ b/sullysmod/mauled.mdx @@ -1,5 +1,6 @@ --- title: The Mauled +sidebar_position: 5 --- import ShowcaseBlock from "../src/components/ShowcaseBlock"; import EntityAttributes, {MobBehavior, WeaponType} from "../src/components/EntityAttributes"; @@ -18,19 +19,20 @@ export const ranged = { export const melee = { type: WeaponType.Melee, weapontype: "iron_sword", - easy: 3, - normal: 5, - hard: 7 + easy: 4, + normal: 7, + hard: 9 } export const spawnRules = [ "Only in deepslate levels", - "In all biomes besides the Deep Dark" + "In all biomes besides the Deep Dark", + "Note: By default the Mauled replaces 20% of vanilla skeletons in deepslate layers. This can be changed in the Config!" ] - - + + + + + + + + + + + + + +The **Piranha** is a fish that spawns in groups in jungle biomes and the mangrove swamp.
+It is only aggressive to small entities, entities that do not have full health, entities that attacked it and boats. +Besides boats, it will only attack organic mobs!
+If the **Piranha** kills an entity that drops meat, it will consume the meat and heal slightly.
+ +If the **Piranha** kills a zombie or a zombie horse, they will turn into a skeleton or a skeleton horse.
+The **Piranha** drops `Raw Piranha` and has a `0.27` chance of dropping a `Piranha Tooth`. + +## Throwing Knife + diff --git a/sullysmod/piranha/_category_.json b/sullysmod/piranha/_category_.json deleted file mode 100644 index 77d4b12..0000000 --- a/sullysmod/piranha/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Piranha" -} \ No newline at end of file diff --git a/sullysmod/potions.mdx b/sullysmod/potions.mdx new file mode 100644 index 0000000..ac08e26 --- /dev/null +++ b/sullysmod/potions.mdx @@ -0,0 +1,8 @@ +--- +title: Potions +sidebar_position: 15 +--- + +## Resistance Potion + +## Unluck Potion \ No newline at end of file diff --git a/sullysmod/potions/_category_.json b/sullysmod/potions/_category_.json deleted file mode 100644 index 59f2823..0000000 --- a/sullysmod/potions/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Potions", - "description": "Some vanilla effects have no potion. We use some sully's mod materials to add them." -} \ No newline at end of file diff --git a/sullysmod/potions/resistance_potion.mdx b/sullysmod/potions/resistance_potion.mdx deleted file mode 100644 index e69de29..0000000 diff --git a/sullysmod/potions/unluck_potion.mdx b/sullysmod/potions/unluck_potion.mdx deleted file mode 100644 index e69de29..0000000 diff --git a/sullysmod/tortoise/_category_.json b/sullysmod/tortoise/_category_.json index 5c9d789..1067f11 100644 --- a/sullysmod/tortoise/_category_.json +++ b/sullysmod/tortoise/_category_.json @@ -1,3 +1,4 @@ { - "label": "Tortoise" + "label": "Tortoise", + "position": 6 } \ No newline at end of file diff --git a/sullysmod/tortoise/index.mdx b/sullysmod/tortoise/index.mdx new file mode 100644 index 0000000..b01c953 --- /dev/null +++ b/sullysmod/tortoise/index.mdx @@ -0,0 +1,4 @@ +--- +title: Tortoise +sidebar_position: 1 +--- \ No newline at end of file diff --git a/sullysmod/tortoise/shell.mdx b/sullysmod/tortoise/shell.mdx new file mode 100644 index 0000000..cdee1ea --- /dev/null +++ b/sullysmod/tortoise/shell.mdx @@ -0,0 +1,3 @@ +--- +title: Tortoise Shell +--- \ No newline at end of file