Merge pull request #5 from TeamGalena/main

TeamGalena · Sep 23, 2024 · f46f183 · f46f183
2 parents 237035a + 1b0be25
commit f46f183
Show file tree

Hide file tree

Showing 19 changed files with 220 additions and 17 deletions.
diff --git a/Makefile b/Makefile
@@ -2,4 +2,10 @@ serve:
 	python -m mkdocs serve
 
 install:
-	pip install -r requirements.txt
+	pip install -r requirements.txt
+
+create-env:
+	python -m venv env
+
+freeze:
+	pip freeze > requirements.txt
diff --git a/README.md b/README.md
@@ -0,0 +1,42 @@
+# Galena Wiki <img src="https://raw.githubusercontent.com/TeamGalena/Wiki/refs/heads/main/docs/assets/logo.png" align="right" height="64" />
+
+This project is based on [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). It's a python framework that generates a static html page from markdown files.
+
+## For Editors
+
+Every page can be edited by modifing the content of it's respective markdown (`.md`) file.
+You are redirected to the github edit dialog by using the edit button visible on every page on the top-right.
+
+For contributers that are not within the organization, this means that you can create a [Fork](https://github.com/TeamGalena/Wiki/fork) and submit your changes/additions using a Pull-Request.
+
+Pages are located withing the `docs` directory and resolve to the following routes:
+
+```
+docs/index.md -> / (the home page)
+docs/something.md -> /something/
+docs/something/index.md -> /something/
+docs/something/else.md -> /something/else/
+docs/something/even/elser.md -> /something/even/elser/
+```
+
+---
+
+## For Developers
+
+### Requirements
+
+- Python 3
+- _make_ (recommended)
+
+it is recommended to create a virtual python environment for the project by running `make create-env`.
+Afterwards, to enable to environment in your shell of choice by running:
+
+```shell
+source env/bin/activate # for linux
+. env/Scripts/Activate.ps1 # for windows powershell
+```
+
+### Running locally
+
+Install the dependencies using `make install` and start a local development server by running `make serve`.
+The hosted website should now be located at `http//localhost:8000` and will hot-reload when any changes are made.
diff --git a/docs/assets/logo.png b/docs/assets/logo.png
diff --git a/docs/fermion/index.md b/docs/fermion/index.md
@@ -0,0 +1 @@
+# Fermion
diff --git a/docs/heart-crystals/index.md b/docs/heart-crystals/index.md
@@ -0,0 +1 @@
+# Heart Crystals
diff --git a/docs/index.md b/docs/index.md
@@ -6,18 +6,20 @@ hide:
 
 # Home
 
+!!! example "This wiki is still very much work in progress"
+
 This wiki contains documentation for several mods made by Team Galena
 
-<div class="grid" markdown style="grid-template-columns: repeat(5, 1fr)">
+<div class="grid hotbar cards" markdown>
 
-[![Oreganized](/assets/oreganized/icon.png)](oreganized)
+[![Oreganized](/assets/oreganized/icon.png)](oreganized "Oreganized")
 
-[![Windswept](/assets/windswept/icon.png)](windswept)
+[![Windswept](/assets/windswept/icon.png)](windswept "Windswept")
 
-[![Overweight Farming](/assets/overweight-farming/icon.png)](overweight-farming)
+[![Overweight Farming](/assets/overweight-farming/icon.png)](overweight-farming "Overweight Farming")
 
-[![Heart Crystals](/assets/heart-crystals/icon.png)](heart-crystals)
+[![Heart Crystals](/assets/heart-crystals/icon.png)](heart-crystals "Heart Crystals")
 
-[![Fermion](/assets/fermion/icon.png)](fermion)
+[![Fermion](/assets/fermion/icon.png)](fermion "Fermion")
 
 </div>
diff --git a/docs/oreganized/electrum.md b/docs/oreganized/electrum.md
@@ -0,0 +1 @@
+# Electrum
diff --git a/docs/oreganized/gargoyle.md b/docs/oreganized/gargoyle.md
@@ -0,0 +1 @@
+# Gargoyle
diff --git a/docs/oreganized/index.md b/docs/oreganized/index.md
@@ -1,9 +1,15 @@
 # Oreganized
 
-![](/assets/oreganized/banner.png){.on-glb : style="height: 200px; width: 100%; object-fit: cover"}
+![](/assets/oreganized/banner.png){.on-glb .banner}
 
-Oreganized is a mod that adds new metals to minecraft.
+[:simple-curseforge: Download on CurseForge](https://www.curseforge.com/minecraft/mc-mods/oreganized){ .md-button .curseforge }
+[:simple-modrinth: Download on Modrinth](https://modrinth.com/mod/oreganized){ .md-button .modrinth }
+[:fontawesome-brands-github: Browse the Sourcecode](https://github.com/Xaidee/oreganised){ .md-button }
 
-Praesent vel gravida diam. Aliquam semper vestibulum nisl sit amet faucibus. Curabitur sagittis orci nec urna lacinia convallis. Integer eu eros consectetur, ullamcorper ligula vitae, finibus felis. Cras sit amet facilisis orci. Maecenas blandit, quam eget convallis fringilla, felis elit dignissim eros, eget mollis lectus nibh ut sem. Donec tincidunt metus et odio egestas tempor. Maecenas iaculis ligula nec molestie vehicula. Quisque dapibus tortor et velit sodales facilisis. Proin id egestas felis. Maecenas interdum, lectus et egestas hendrerit, urna mi fringilla nulla, in dictum odio dolor sit amet augue. Nam euismod neque sed diam aliquam pharetra. Proin scelerisque fermentum pretium. Nullam sollicitudin tellus maximus, mattis mauris eu, vestibulum quam. Nulla venenatis nisl id sapien fermentum, sed efficitur sem sagittis.
+Oreganized is a mod inspired by the 1.17 inclusion of Copper in minecraft and imagines how would 2 new metals look like if they were added today.
+Each with their unique niches and themes.
 
-Sed egestas finibus viverra. Etiam nec mollis magna. Fusce ut mi vitae felis mollis hendrerit. Duis lobortis mi a augue scelerisque mollis. Duis at nulla vel diam iaculis placerat. Curabitur ornare, augue ornare aliquet ullamcorper, nulla magna ultrices ex, at porttitor arcu lacus non libero. Maecenas cursus euismod magna, in tristique sapien ultricies id. Integer maximus lorem sed lobortis dapibus.
+Silver ![]({{ hosts.icons }}/oreganized/silver_ingot.png){ .inline-icon } can be made into Mirrors, [Scribe](scribe.md), [Gargoyles](gargoyle.md) and make a new alloy called [Electrum](electrum.md).
+
+Lead ![]({{ hosts.icons }}/oreganized/lead_ingot.png){ .inline-icon } can be used for [decoration](lead-decoration.md), melted and for [Lead Bolts](lead-bolt.md) - new projectiles!
+The world is also filled with an adjacent features to the metals like the new Boulders which you can find in plains that are the source of a new stone type
diff --git a/docs/oreganized/lead-bolt.md b/docs/oreganized/lead-bolt.md
@@ -0,0 +1 @@
+# Lead Bolt
diff --git a/docs/oreganized/lead-bulb.md b/docs/oreganized/lead-bulb.md
@@ -0,0 +1,9 @@
+# Lead Bulb
+
+<div class="grid aside" markdown>
+
+Nulla semper turpis risus, vel finibus magna tristique tincidunt. Nunc feugiat est sed tortor ultrices, ut dictum arcu auctor. Fusce facilisis ac dolor at accumsan. Suspendisse eget velit vehicula, aliquam lacus eu, pellentesque neque. Vestibulum vel aliquet erat, sed luctus nisi. Proin vel neque massa. Donec tempus sem felis, ac congue nisl viverra eu. Quisque hendrerit elit sodales, pharetra metus nec, vulputate ante. Nullam placerat nibh leo, eu sodales enim faucibus sit amet. Fusce lobortis vehicula nunc, in commodo ex blandit a.
+
+![Lead Bulb]({{ hosts.icons }}/oreganized/lead_bulb.png)
+
+</div>
diff --git a/docs/oreganized/lead-decoration.md b/docs/oreganized/lead-decoration.md
@@ -2,12 +2,53 @@
 
 ### Lead Blocks
 
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent pretium tellus vitae mauris convallis lobortis. Praesent molestie justo elit, eget vulputate risus vestibulum in. Vivamus tincidunt ac odio at tempus. Nullam rutrum interdum turpis sit amet semper. Morbi quis augue venenatis, tristique justo a, feugiat quam. Donec faucibus est sit amet efficitur porttitor. Nulla non mattis dolor. Aenean maximus, mauris sit amet tempor euismod, nunc quam interdum diam, vitae imperdiet nisl arcu vel risus. Etiam viverra augue vel felis pretium, at sodales tellus condimentum. Duis mattis metus a diam convallis, sed cursus odio suscipit. Proin lectus mauris, aliquam tristique ultricies id, convallis a ligula. Quisque rhoncus, nisl non tempor pharetra, nibh nulla volutpat nunc, quis laoreet quam sem ac nisl. Nullam nulla ex, cursus sit amet mi id, iaculis varius eros. Maecenas at porttitor ligula. Proin ipsum nisl, elementum at egestas vitae, rhoncus a justo. Fusce bibendum nisi sit amet est blandit sollicitudin.
+There are different decorative blocks made out of lead. Like most things made out of lead, the will start to melt when placed next to a heat source (See [Melting](melting.md))
 
-### Lead Bars
+<div class="grid hotbar" style="max-width: 500px;" markdown>
+
+![Lead Block]({{ hosts.icons }}/oreganized/lead_block.png)
+
+![Cut Lead]({{ hosts.icons }}/oreganized/cut_lead.png)
+
+![Lead Pillar]({{ hosts.icons }}/oreganized/lead_pillar.png)
+
+![Lead Bricks]({{ hosts.icons }}/oreganized/lead_bricks.png)
 
-Nulla semper turpis risus, vel finibus magna tristique tincidunt. Nunc feugiat est sed tortor ultrices, ut dictum arcu auctor. Fusce facilisis ac dolor at accumsan. Suspendisse eget velit vehicula, aliquam lacus eu, pellentesque neque. Vestibulum vel aliquet erat, sed luctus nisi. Proin vel neque massa. Donec tempus sem felis, ac congue nisl viverra eu. Quisque hendrerit elit sodales, pharetra metus nec, vulputate ante. Nullam placerat nibh leo, eu sodales enim faucibus sit amet. Fusce lobortis vehicula nunc, in commodo ex blandit a.
+</div>
 
 ### Lead Doors
 
-Duis luctus dignissim mauris. Nulla enim nulla, facilisis nec quam ut, dapibus pulvinar sem. Maecenas id commodo sapien. Maecenas enim purus, vehicula nec erat eu, vestibulum mollis tortor. Nullam orci orci, tempor vitae ex eget, congue porta libero. Vivamus a massa nisi. Nam rutrum ipsum at lectus gravida, ac sollicitudin neque feugiat. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed non justo malesuada, vehicula lectus at, mollis mauris. Sed ut dui accumsan, pharetra nulla ut, scelerisque ante. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Quisque finibus pellentesque pretium. Donec sit amet mauris semper, elementum eros porta, feugiat sem. Phasellus rhoncus non velit tempus scelerisque.
+<div class="grid aside" markdown>
+
+<div markdown>
+Lead doors and trapdoors work the same and have two features that differentiate them from other doors.
+They cannot be opened using redstone but only by hand.
+Instead of openening instantly, players need to press a few seconds to push them open.
+Letting go of the door will cause it to close after a second again.
+
+The second mechanic is that similar to other lead blocks, heating affects the way they can be used.
+Melting it into the goopy state, damage cause the players while they press it open,
+in the red hot state it will only hurt but not even open anymore.
+
+</div>
+
+<div class="grid" markdown>
+
+![Lead Door]({{ hosts.icons }}/oreganized/lead_door.png)
+
+![Lead Trapdoor]({{ hosts.icons }}/oreganized/lead_trapdoor.png)
+
+</div>
+
+</div>
+
+### Lead Bars
+
+<div class="grid aside" markdown>
+
+Lead bars are more fragile than other lead blocks. This prevents them from reforming after being completely molten into the red hot state.
+Instead, when mined in this state or when they cool down again, they break down and drop a few lead nuggets ![]({{ hosts.icons }}/oreganized/lead_nugget.png){ .inline-icon }
+
+![Lead Bars]({{ hosts.icons }}/oreganized/lead_bars.png)
+
+</div>
diff --git a/docs/oreganized/melting.md b/docs/oreganized/melting.md
@@ -0,0 +1,29 @@
+# Melting
+
+When subjected to heat, blocks made out of lead will start to melt.
+
+Placing them directly next to a heat source like campfires ![]({{ hosts.icons }}/minecraft/campfire.png){ .inline-icon },
+magma blocks ![]({{ hosts.icons }}/minecraft/magma_block.png){ .inline-icon } or lava ![]({{ hosts.icons }}/minecraft/lava_bucket.png){ .inline-icon }
+will cause them to turn into a red hot state, look indistinguishable from one another.
+
+Lead blocks placed next to goopy blocks will turn into their goopy form.
+
+These molten states of blocks will hurt when standing on them. Some blocks, like the
+[lead door ![]({{ hosts.icons }}/oreganized/lead_door.png){ .inline-icon }](lead-decoration.md#lead-doors),
+[lead bulb ![]({{ hosts.icons }}/oreganized/lead_bulb.png){ .inline-icon }](lead-bulb.md) or
+[lead bars ![]({{ hosts.icons }}/oreganized/lead_bars.png){ .inline-icon }](lead-decoration.md#lead-bars)
+also behave differently based on their heat level.
+
+<div class="grid hotbar" style="max-width: 600px" markdown>
+
+![Lead Block]({{ hosts.icons }}/oreganized/lead_block.png)
+
+:material-arrow-right-thick:
+
+![Goopy Lead Block]({{ hosts.icons }}/oreganized/goopy_lead_block.png)
+
+:material-arrow-right-thick:
+
+![Red Hot Lead Block]({{ hosts.icons }}/oreganized/red_hot_lead.png)
+
+</div>
diff --git a/docs/oreganized/scribe.md b/docs/oreganized/scribe.md
@@ -0,0 +1 @@
+# Scribe
diff --git a/docs/overweight-farming/index.md b/docs/overweight-farming/index.md
@@ -0,0 +1 @@
+# Overweight Farming
diff --git a/docs/styles/extra.css b/docs/styles/extra.css
@@ -0,0 +1,45 @@
+.md-typeset {
+  .banner {
+    height: 200px;
+    width: 100%;
+    object-fit: cover;
+  }
+
+  .aside {
+    grid-template-columns: 3fr 1fr;
+    gap: 1.6rem;
+
+    .grid {
+      grid-template-columns: repeat(2, 1fr);
+    }
+  }
+
+  .hotbar {
+    grid-auto-flow: column;
+    grid-template-columns: unset;
+
+    align-items: center;
+    margin-left: auto;
+    margin-right: auto;
+
+    p > .twemoji {
+      font-size: 1.6rem;
+    }
+  }
+
+  .inline-icon {
+    display: inline-block;
+    height: 1.6em;
+    margin-bottom: -0.4em;
+  }
+
+  .curseforge {
+    --md-primary-fg-color: #f16436;
+    --md-accent-fg-color: #ff784d;
+  }
+
+  .modrinth {
+    --md-primary-fg-color: #1bd96a;
+    --md-accent-fg-color: #22ff84;
+  }
+}
diff --git a/docs/windswept/index.md b/docs/windswept/index.md
@@ -1,6 +1,6 @@
 # Windswept
 
-![](/assets/windswept/banner.png){.on-glb : style="height: 200px; width: 100%; object-fit: cover"}
+![](/assets/windswept/banner.png){.on-glb .banner}
 
 Nulla semper turpis risus, vel finibus magna tristique tincidunt. Nunc feugiat est sed tortor ultrices, ut dictum arcu auctor. Fusce facilisis ac dolor at accumsan. Suspendisse eget velit vehicula, aliquam lacus eu, pellentesque neque. Vestibulum vel aliquet erat, sed luctus nisi. Proin vel neque massa. Donec tempus sem felis, ac congue nisl viverra eu. Quisque hendrerit elit sodales, pharetra metus nec, vulputate ante. Nullam placerat nibh leo, eu sodales enim faucibus sit amet. Fusce lobortis vehicula nunc, in commodo ex blandit a.
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,7 +8,7 @@ theme:
   palette:
     scheme: slate
     primary: deep purple
-    accent: deep purple
+    accent: indigo
 
   logo: assets/icon.svg
   favicon: assets/icon.svg
@@ -24,6 +24,7 @@ theme:
     - navigation.indexes
     - toc.integrate
     - navigation.top
+    - content.tooltips
 
 extra:
   social:
@@ -39,19 +40,31 @@ extra:
     - icon: fontawesome/brands/github
       link: https://github.com/TeamGalena
 
+  hosts:
+    icons: https://icons.macarena.ceo/icons
+
 markdown_extensions:
   - attr_list
   - md_in_html
   - tables
   - admonition
   - pymdownx.details
   - pymdownx.superfences
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  - abbr
+  - pymdownx.snippets
 
 plugins:
   - search
+  - markdownextradata:
   - git-revision-date-localized:
       enabled: !ENV [CI, false]
   - glightbox:
       manual: true
   - social:
       enabled: !ENV [CI, false]
+
+extra_css:
+  - styles/extra.css
diff --git a/requirements.txt b/requirements.txt
@@ -12,6 +12,7 @@ ghp-import==2.1.0
 gitdb==4.0.11
 GitPython==3.1.43
 idna==3.10
+importlib_metadata==8.5.0
 Jinja2==3.1.4
 Markdown==3.7
 MarkupSafe==2.1.5
@@ -20,6 +21,7 @@ mkdocs==1.6.1
 mkdocs-get-deps==0.2.0
 mkdocs-git-revision-date-localized-plugin==1.2.9
 mkdocs-glightbox==0.4.0
+mkdocs-markdownextradata-plugin==0.2.6
 mkdocs-material==9.5.35
 mkdocs-material-extensions==1.3.1
 packaging==24.1
@@ -42,3 +44,4 @@ tinycss2==1.3.0
 urllib3==2.2.3
 watchdog==5.0.2
 webencodings==0.5.1
+zipp==3.20.2