docs: restore website content

Support-Launcher · Jun 20, 2024 · 26f6e37 · 26f6e37
1 parent 3533c14
commit 26f6e37
Show file tree

Hide file tree

Showing 39 changed files with 403 additions and 5,236 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -23,68 +23,47 @@ concurrency:
   group: "pages"
   cancel-in-progress: true
 
-env:
-  NEXT_PUBLIC_BASE_PATH: /launcher-tutorials
+# Default to bash
+defaults:
+  run:
+    shell: bash
 
 jobs:
   # Build job
   build:
     runs-on: ubuntu-latest
+    env:
+      HUGO_VERSION: 0.127.0
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          fetch-depth: 0
-      - name: Detect package manager
-        id: detect-package-manager
-        run: |
-          if [ -f "${{ github.workspace }}/yarn.lock" ]; then
-            echo "manager=yarn" >> $GITHUB_OUTPUT
-            echo "command=install" >> $GITHUB_OUTPUT
-            echo "runner=yarn" >> $GITHUB_OUTPUT
-            exit 0
-          elif [ -f "${{ github.workspace }}/package.json" ]; then
-            echo "manager=npm" >> $GITHUB_OUTPUT
-            echo "command=ci" >> $GITHUB_OUTPUT
-            echo "runner=npx --no-install" >> $GITHUB_OUTPUT
-            exit 0
-          else
-            echo "Unable to determine packager manager"
-            exit 1
-          fi
-      - name: Setup Node
-        uses: actions/setup-node@v3
+          fetch-depth: 0 # fetch all history for .GitInfo and .Lastmod
+          submodules: recursive
+      - name: Setup Go
+        uses: actions/setup-go@v5
         with:
-          node-version: "16"
-          cache: ${{ steps.detect-package-manager.outputs.manager }}
+          go-version: "1.22"
       - name: Setup Pages
-        uses: actions/configure-pages@v3
-        with:
-          # Automatically inject basePath in your Next.js configuration file and disable
-          # server side image optimization (https://nextjs.org/docs/api-reference/next/image#unoptimized).
-          #
-          # You may remove this line if you want to manage the configuration yourself.
-          static_site_generator: next
-      - name: Restore cache
-        uses: actions/cache@v3
-        with:
-          path: |
-            .next/cache
-          # Generate a new cache whenever packages or source files change.
-          key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
-          # If source files changed but packages didn't, rebuild from a prior cache.
-          restore-keys: |
-            ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-
-      - name: Install dependencies
-        run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
-      - name: Build with Next.js
-        run: ${{ steps.detect-package-manager.outputs.runner }} next build
-      - name: Static HTML export with Next.js
-        run: ${{ steps.detect-package-manager.outputs.runner }} next export
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Setup Hugo
+        run: |
+          wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
+          && sudo dpkg -i ${{ runner.temp }}/hugo.deb
+      - name: Build with Hugo
+        env:
+          # For maximum backward compatibility with Hugo modules
+          HUGO_ENVIRONMENT: production
+          HUGO_ENV: production
+        run: |
+          hugo \
+            --gc --minify \
+            --baseURL "${{ steps.pages.outputs.base_url }}/"
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
-          path: ./out
+          path: ./public
 
   # Deployment job
   deploy:
@@ -96,4 +75,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v4
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,4 @@
 .vscode/
-.idea/
+.idea/
+
+public/
diff --git a/content/_index.md b/content/_index.md
@@ -1,5 +1,22 @@
-+++
-title = ''
-date = 2024-06-20T10:41:31+02:00
-draft = true
-+++
+---
+title: "Introduction"
+date: 2024-06-20T10:41:31+02:00
+draft: true
+cascade:
+  type: docs
+---
+
+Bienvenue sur Launcher Tutorials ! Différents tutoriels sont répertoriés autour de la création de launcher Minecraft.
+
+## Pourquoi ce site ?
+
+Ce site a été créé pour aider les personnes qui souhaitent créer un launcher Minecraft. Il est composé de tutoriels qui vous permettront de créer un launcher Minecraft de A à Z. Il existe en complément un [Discord](https://discord.gg/SAy4bVQgHD) où vous pourrez poser vos questions et obtenir de l'aide.
+
+## Comment contribuer ?
+
+Vous pouvez contribuer à ce site en proposant des tutoriels ou en corrigeant des erreurs. Pour cela, vous pouvez créer une
+[Pull Request](https://github.com/bricklou/launcher-tutorials/pulls) sur le dépôt GitHub du site.
+
+## Contributeurs
+
+[![](https://contrib.rocks/image?repo=bricklou/launcher-tutorials)](https://github.com/bricklou/launcher-tutorials/graphs/contributors)
diff --git a/content/docs/_index.md b/content/docs/_index.md
diff --git a/content/faq.md b/content/faq.md
@@ -0,0 +1,14 @@
+---
+title: "FAQ"
+date: 2024-06-20T11:36:46+02:00
+weight: 1
+draft: true
+---
+
+Tu trouveras ici les réponses aux questions les plus fréquentes.
+Si tu as une question qui n'est pas dans cette liste, n'hésite pas à nous la proposer sur [GitHub](https://github.com/bricklou/launcher-tutorials/issues/new).
+
+{{< callout type="warning" emoji="⚠️" >}}
+Cette page est un peu vide pour le moment, mais elle va s'étoffer au fur et à
+mesure que nous recevrons des questions.
+{{< /callout >}}
diff --git a/content/flow-updater/_index.md b/content/flow-updater/_index.md
@@ -0,0 +1,21 @@
+---
+title: "Flow Updater"
+date: 2024-06-20T11:36:46+02:00
+draft: true
+weight: 3
+---
+
+_"The free and open source solution to update Minecraft."_
+
+## Introduction
+
+**Flow Updater** est aujourd'hui un outil indispensable pour mettre à jour une installation Minecraft.
+Créé par [Flow Arg](https://github.com/FlowArg) en 2020, FlowUpdater bénéficie aujourd'hui d'une communauté prête à vous aider en cas de problème.
+La bibliothèque est disponible à partir de Java 8 et est compatible à ce jour jusqu'à Java 19.
+
+[Ce projet open-source](https://github.com/FlowArg/FlowUpdater) permet d'installer en plus d'une version vanilla, un mod loader (Forge, Fabric, ...) des mods en provenance de plusieurs plateformes (CurseForge, Modrinth, votre propre serveur) et même un mod pack complet !
+Il est également possible d'ajouter des resource packs, des options par défaut, etc...
+
+Vous pouvez contribuez à ce projet en proposant des idées sur le [Discord](https://discord.gg/dN6HWHp), en ouvrant directement une [issue](https://github.com/FlowArg/FlowUpdater/issues) pour signaler un bug ou en créant une [Pull Request](https://github.com/FlowArg/FlowUpdater/pulls) pour proposer des modifications dans le code.
+
+Sur cette documentation, vous retrouverez des tutoriels à jour sur l'utilisation de la bibliothèque (si ils sont dépassés, n'hésitez pas à nous le signaler !) pour vous aider à mettre en place Flow Updater dans votre projet.
diff --git a/content/flow-updater/vanilla.md b/content/flow-updater/vanilla.md
@@ -0,0 +1,9 @@
+---
+title: "Vanilla"
+date: 2024-06-20T11:36:46+02:00
+draft: true
+---
+
+## Tutoriel Vanilla
+
+W.I.P
diff --git a/content/open-auth.md b/content/open-auth.md
@@ -0,0 +1,146 @@
+---
+title: "Open Auth"
+date: 2024-06-20T11:36:46+02:00
+draft: true
+weight: 2
+---
+
+## Introduction
+
+[Open Auth](https://github.com/litarvan/openauth) est une librairie Java développée par [Litarvan](https://github.com/litarvan) qui offre une méthode rapide pour s'authentifier via les services officiels pour un client Minecraft.
+Dans cet article, nous parlerons exclusivement de l'authentification (cité sous le nom "d'auth" à partir de maintenant) par un compte Microsoft. En effet, désormais Mojang supporte uniquement cette méthode.
+
+## Importer la librairie
+
+Cette librairie est hébergée sur le maven de Litarvan, vous pouvez donc l'importer dans votre projet comme ceci :
+
+Avec Gradle :
+
+```groovy {filename=build.gradle}
+repositories {
+    mavenCentral()
+    maven {
+        url = 'https://jitpack.io'
+        name = 'JitPack'
+    }
+}
+
+dependencies {
+    implementation 'com.github.litarvan:openauth:518589d222'
+}
+
+```
+
+Avec Maven :
+
+```xml {filename=pom.xml}
+<repositories>
+    <repository>
+        <id>JitPack</id>
+        <url>https://jitpack.io</url>
+    </repository>
+</repositories>
+<dependencies>
+    <dependency>
+        <groupId>com.github.litarvan</groupId>
+        <artifactId>openauth</artifactId>
+        <version>518589d222</version>
+    </dependency>
+</dependencies>
+```
+
+{{< callout emoji="✅" type="info" >}}
+À l'heure où est écrit ce tutoriel, la dernière version disponible est la
+**1.1.5** (qui est le commit `518589d222`, puisque cette version n'a pas été publié). Allez sur la page des
+[releases](https://github.com/Litarvan/OpenAuth/releases) pour voir la
+dernière version disponible.
+{{< /callout >}}
+
+## Authentification
+
+Plusieurs méthodes d'auth sont disponibles en fonction des besoins de l'application que vous développez.
+
+{{< callout emoji="⚠️" type="warning" >}}
+Il faut choisir **une seule** méthode d'auth parmi les suivantes.
+{{< /callout >}}
+
+Pour toutes les méthodes d'auth suivantes, il faut déclarer un objet de type `MicrosoftAuthenticator` comme ceci :
+
+```java
+MicrosoftAuthenticator authenticator = new MicrosoftAuthenticator();
+```
+
+### Auth par "Credentials":
+
+Cette méthode permet de se connecter avec l'email et le mot de passe du compte Microsoft, elle peut être utile dans le cas ou l'application intègre ses propres champs de texte pour la connexion.
+Nonobstant, cette méthode est déconseillée car elle n'est pas sécurisée, et peut être utilisée pour récupérer des informations sensibles par l'application (puisqu'elle traîte directement les informations de connexion). De plus, cette méthode ne supporte pas la double authentification "A2F".
+Voici comment l'utiliser :
+
+```java
+// ...
+MicrosoftAuthResult result = authenticator.loginWithCredentials("email", "password");
+```
+
+### Auth par "WebView":
+
+Cette méthode permet de se connecter avec une interface de connexion Microsoft, comme ceci :
+
+![Image de la webview Microsoft](https://sharepointmaven.com/wp-content/uploads/2022/09/brandloginwindowmicrosoft3651.jpg)
+
+Voici comment l'utiliser :
+
+```java
+...
+MicrosoftAuthResult result = authenticator.loginWithWebView();
+```
+
+{{< callout emoji="✅" type="info" >}}
+Attention, cette méthode n'est pas une méthode asynchrone, c'est a dire que
+votre programme ne tournera plus en arrière plan lorsque cette fenêtre sera
+ouverte si elle n'est pas ouverte dans un autre thread. Cela peut causer des
+problèmes, par exemple : votre interface graphique pourra être gelée et vous
+aurez un beau message de votre OS vous informant que le programme ne répond
+plus.
+{{< /callout >}}
+
+Si vous voulez utiliser la méthode asynchrone, utilisez simplement `loginWithAsyncWebView` au lieu de `loginWithWebView`;
+
+### Auth par "RefreshToken:
+
+Cette méthode d'auth permet de se connecter avec un _refresh_token_, elle est utilisée pour éviter de se reconnecter à chaque lancement.
+Le _refresh_token_ est récupérable avec une authentification basique, sauvegardez le dans un fichier pour le récupérer au prochain lancement.
+Voici comment l'utiliser :
+
+```java
+// ...
+MicrosoftAuthResult result = authenticator.loginWithRefreshToken("refresh token");
+```
+
+### Auth par "DeviceId"
+
+_Cette auth est en cours d'écriture, elle permettrait de ne pas utiliser la webView et d'ouvrir une page internet pour taper un code, comme il est fait dans le launcher de multiMc_
+
+## Résultat
+
+Pour toutes ces méthodes d'auth, nous obtenons un objet result de type `MicrosoftAuthResult`. Cet objet nous permet de récupérer plusieurs informations sur le compte que nous venons de connecter :
+
+- le profil avec la méthode `result.getProfile()`
+- l'accesToken avec la méthode `result.getAccessToken()`
+- le refreshToken avec la méthode `result.getRefreshToken()`
+- l'xuid avec la méthode `result.getXuid()`
+- le clientId avec la méthode `result.getClientId()`
+
+Les deux derniers ids sont nécessaires notamment pour les authentifications à partir de la 1.18.
+
+### Le profil
+
+La méthode `result.getProfile()` retourne uen objet de type `MinecraftProfile`, qui peut être utilisé avec les méthodes suivantes :
+
+- `getId()` permets de récupérer l'UUID du compte minecraft
+- `getName()` permets de récupérer le nom du compte du joueur
+- `getSkins()` permets de récupérer la liste des skins du joueur sous forme de MinecraftSkin[] (je ne détaillerais pas ici l'utilisation de cette classe que vous pouvez trouver [ici](https://github.com/Litarvan/OpenAuth/blob/518589d22210bf0763d9ae19d546ddf1dba3fb8c/src/main/java/fr/litarvan/openauth/microsoft/model/response/MinecraftProfile.java#L60))
+
+### Les tokens
+
+- L'_acces token_ est utilisé pour lancer le jeu, par exemple avec la librairie [OpenLauncherLib](https://github.com/FlowArg/OpenLauncherLib)
+- Le _refresh token_, dont nous avons déjà parlé avant, permet quant à lui de se reconnecter directement, sans avoir à rentrer de mot de passe, il est donc pratique de le sauvegarder dans un fichier après la connexion.
diff --git a/public/css/custom.css → content/swing-launcher/_index.md b/public/css/custom.css → content/swing-launcher/_index.md
diff --git a/content/swing-launcher/getting-started.md b/content/swing-launcher/getting-started.md
@@ -0,0 +1,23 @@
+---
+title: "Documentation de SwingLauncher"
+linkTitle: "Getting started"
+date: 2024-06-20T11:36:46+02:00
+draft: true
+---
+
+Ici, vous allez trouver des informations concernant le code du swing template.
+
+## Avant de commencer
+
+S'il vous plait, ayez une bonne connaissance de votre sujet (java, swing) pour ne pas être perdu dans votre projet.
+
+## Installation
+
+- Pour créer votre launcher en utilisant le [repo github](https://github.com/support-launcher/swinglauncher), clonez-le via git sur votre ordinateur.
+- Ouvrez le projet avec l'ide que vous souhaitez (Intellij IDEA est fortement recommandé).
+
+À présent vous êtes prêt à coder votre launcher !
+
+{{< callout type="warning" emoji="⚠️" >}}
+Faites attention à ouvrir le bon dossier !
+{{< /callout >}}