Merge pull request #8 from TathanDev/docs

Player Wiki

.vitepress/config.mjs

@@ -5,23 +5,36 @@ export default defineConfig({
   base: '/stellaris/',
   title: "The Stellaris Project Documentation",
   description: "Learn how to create your own planets !",
+  head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'Create a planet', link: '/custom-planets' },
-      { text: 'Configure the screen', link: '/custom-screen' },
+      { text: 'Documention', link: '/custom-planets' },
+      { text: 'Wiki', link: '/wiki/getting-started' },
       { text: 'Team', link: '/team' }
 
     ],
 
     sidebar: [
       {
-        text: 'Create a planet',
+        text: 'Documentation',
         items: [
           { text: 'The Planet file', link: '/custom-planets' },
           { text: 'The Screen files', link: '/custom-screen' }
         ]
+      },
+      {
+        text: 'Wiki',
+        items: [
+          { text: 'Getting Started', link: '/wiki/getting-started' },
+          { text: 'Fuel', link: '/wiki/fuel' },
+          { text: 'Electricity', link: '/wiki/electricity' },
+          { text: 'Rocket', link: '/wiki/rocket' },
+
+          { text: 'FAQ', link: '/wiki/faq' }
+
+        ]
       }
     ],
 
@@ -30,7 +43,12 @@ export default defineConfig({
       { icon: 'youtube', link: 'https://www.youtube.com/channel/UCzrr9q1Afqu-Yb9i7nn1uPA' },
       { icon: 'discord', link: 'https://discord.gg/project-stellaris-698598471896268931' }
 
-    ]
+    ],
+
+    footer: {
+      message: 'Made by the Stellaris team with 💖.'
+    }
+
   },
   markdown: {
     math: true

index.md

@@ -14,8 +14,8 @@ hero:
       text: Custom Screen
       link: /custom-screen
     - theme: brand
-      text: Add Stellaris to your project
-      link: /maven-repo
+      text: Wiki
+      link: /wiki/fuel
 features:
   - title: Easy as cake
     details: Creating addons is very easy with the datapacks support

wiki/electricity.md

@@ -0,0 +1,29 @@
+# Electricity
+
+In Project Stellaris, a lot of machines need to be powered by Electricity.
+
+## Generators
+
+The mod contains multiple blocks that can generate electricity
+
+| Blocks                |      Use                      |  Max Generation (Fe/Tick)|
+| --------------------- | :---------------------------: | ----: |
+| Solar Panel           | Need to be set under the sun  | 1     |
+| Radioactive Generator |   Need Radioactive blocks     | 500   |
+
+
+
+## Power other machines
+
+Now that you have electricity, you need to power other machines. For this, there are two ways :
+
+- First, you can set a generator next to a machine
+    ![Next to a machine](/screens/generators-glued.png)
+
+- You can also use a cable
+    ![Next to a machine](/screens/cable.png)
+
+
+::: info
+The `Generators blocks` and `Machines` from Stellaris are compatible with other tech mods.
+:::

wiki/faq.md

@@ -0,0 +1,18 @@
+# FAQ
+
+You have questions ? We have answers !
+
+### Why I can't eat in planets ?
+- Players can't eat if they are in planets not having oxygen. To solve this problem, you need to use the vacumator to put food into a can.
+
+
+### This mod looks like an other one... Are you stealing a mod ?
+- Nop ! We don't steal other people mods ! Project Stellaris has been created by the mainteners of Beyond Earth and re-use assets from this mod. The creators of Ad Astra also used assets from Beyond Earth so it's normal if theses both mod looks the same !
+
+
+### Is this mod will be available for this minecraft version ?
+- We have planned to backport Stellaris on multiple minecraft version like `1.18.2`, `1.19.X` and `1.20.1`. If the minecraft version you want is not in this list, you can join the [discord](https://discord.gg/project-stellaris-698598471896268931) to ask if we can backport it. But remember : we are making the mod in our free time !
+
+::: info
+If you have others question, join the [discord](https://discord.gg/project-stellaris-698598471896268931) to ask them to the team
+:::

wiki/fuel.md

@@ -0,0 +1,30 @@
+# Fuel
+
+In Project Stellaris, one of the main resource is the Fuel. It allow you to use Rocket and JetSuit.
+
+## Get Oil
+
+First, you will need to find a oil lake. It spawn underground or rarely on the surface. This lake contains oil that you can retrieve with a bucket.
+
+![Underground Oil](/underground-oil.png)
+
+
+## Craft the Fuel Rafinery
+
+Now, you need to transform the oil to fuel. This is possible because of the Fuel Rafinery Block.
+
+![Fuel Refinery](/recipes/fuel_refinery.png)
+
+::: warning
+The `Fuel Rafinery` block need to be powered.
+:::
+
+## Usage
+
+If Oil is present in the first tank and if the block is powered, the oil will be transfered into Fuel.
+
+The Slot at the right top has two function :
+- When putting a bucket, the bucket will be filled with Fuel
+- When putting a JetSuit Chestplate, the JetSuit Chestplate will be filled with fuel
+
+![Fuel Refinery](/menus/fuel_refinery.png)

wiki/getting-started.md

@@ -0,0 +1,21 @@
+# Getting Started
+
+Welcome to the wiki of the Stellaris Project !
+
+## Install the mod
+
+The Stellaris Project is currently available for Minecraft `1.20.6`
+
+
+### Mod and Depency
+| Mod                   |      Link                     | Required |
+| --------------------- | :---------------------------: |  :---------------------------:       |
+| Stellaris             | [Curseforge](https://legacy.curseforge.com/minecraft/mc-mods/stellaris)  | true
+| Architectury API      |   [Curseforge](https://www.curseforge.com/minecraft/mc-mods/architectury-api) [Modrinth](https://modrinth.com/mod/architectury-api) | true |
+| JEI      |   [Curseforge](https://www.curseforge.com/minecraft/mc-mods/jei)| false |
+
+Stellaris contains a lot of blocks/items. You should use JEI/REI into your modpack for the recipes
+
+::: tip
+Stellaris is available for Fabric and Neoforge !
+:::

wiki/rocket.md

@@ -0,0 +1,47 @@
+# Rocket
+
+Want to go to space and explore new planets ? Well you first need a rocket !
+
+## Crafting the rocket
+
+First, you will need to craft the `Rocket Station`
+
+![Rocket Station craft](/recipes/rocket_station.png)
+
+Then, you will be able to craft the Rocket
+
+![Fuel Refinery](/recipes/rocket.png)
+
+::: warning
+There is only one recipe for the `Rocket`. You will be able to modify it with upgrades
+:::
+
+## Place your rocket
+
+To place your rocket, you need 9 `Rocket Launch Pad` and create this structure :
+
+![Launch Pads](/screens/launch-pad.png)
+
+Then, you just need to right click on the launch pads with your `Rocket`
+
+## Starting your rocket
+
+To start your rocket, you need to input some fuel in the left top slot. Then, when the Fuel Tank is full, just press the space bar !
+
+
+## Upgrades
+
+Want to pimp your rocket or explore planets even farther ? It's possible with `Rocket Upgrade` !
+
+There are four type of Rocket Upgrades :
+
+- **Motor Upgrade** : This upgrade change the fuel needed by the Rocket
+- **Tank upgrade** : This upgrade change the maximum capacity of the Rocket fuel tank
+- **Model Upgrade** : This upgrade change the model of the rocket
+- **Skin Upgrade** : This upgrade change the skin of the rocket
+
+![Launch Pads](/screens/rocket-pimp.png)
+
+To applied theses upgrade, enter the rocket, open your inventory and place the upgrade in the good slot (It's one of the four slots at the bottom)
+
+![Launch Pads](/screens/rocket.png)