From 873bba1c0ff250534d6a02e67ea2590c5d77127d Mon Sep 17 00:00:00 2001 From: alexytomi <60690056+alexytomi@users.noreply.github.com> Date: Sat, 28 Dec 2024 23:32:38 +0800 Subject: [PATCH] Finish rebasing on Dev1ss0/PojavlauncherWikiTesting:Dev1ss0-testing --- .gitignore | 1 + .nvmrc | 1 - .vuepress/config.js | 204 ------------------ markdown/.vuepress/README.md | 12 -- markdown/.vuepress/arrays.js | 100 ++++----- markdown/.vuepress/bars.js | 6 +- markdown/.vuepress/config.js | 2 +- .../changelogs}/ANDROID.md | 0 {changelogs => markdown/changelogs}/IOS.md | 0 .../wiki/faq/INSTALLATIONOFMODSRPWORLDS.md | 0 markdown/wiki/faq/RPWORLDNOTSHOWINGUP.md | 21 -- markdown/wiki/getting_started/DISCORD.md | 12 -- .../wiki/getting_started/SOCIALMEDIA.md | 0 13 files changed, 55 insertions(+), 304 deletions(-) delete mode 100644 .nvmrc delete mode 100644 .vuepress/config.js rename {changelogs => markdown/changelogs}/ANDROID.md (100%) rename {changelogs => markdown/changelogs}/IOS.md (100%) rename INSTALLATIONOFMODSRPWORLDS.md => markdown/wiki/faq/INSTALLATIONOFMODSRPWORLDS.md (100%) delete mode 100644 markdown/wiki/faq/RPWORLDNOTSHOWINGUP.md delete mode 100644 markdown/wiki/getting_started/DISCORD.md rename SOCIALMEDIA.md => markdown/wiki/getting_started/SOCIALMEDIA.md (100%) diff --git a/.gitignore b/.gitignore index a2e870a5..627dbba9 100644 --- a/.gitignore +++ b/.gitignore @@ -22,3 +22,4 @@ docs/ package-lock.json .editorconfig +.nvmrc \ No newline at end of file diff --git a/.nvmrc b/.nvmrc deleted file mode 100644 index b009dfb9..00000000 --- a/.nvmrc +++ /dev/null @@ -1 +0,0 @@ -lts/* diff --git a/.vuepress/config.js b/.vuepress/config.js deleted file mode 100644 index ab36db01..00000000 --- a/.vuepress/config.js +++ /dev/null @@ -1,204 +0,0 @@ -const { description } = require('../package') -const vuepressBar = require('vuepress-bar'); - -const { sidebar } = vuepressBar({ - addReadMeToFirstGroup: false, -}); - -module.exports = { - title: 'PojavLauncher', - description: 'A flexible, fast and open-source Minecraft Java Edition launcher for Android and iOS', - head: [ - ['meta', { - name: 'theme-color', - content: '#ffffff', - media: '(prefers-color-scheme: light)' - }], - ['meta', { - name: 'theme-color', - content: '#25262b', - media: '(prefers-color-scheme: dark)' - }], - ['meta', { - name: 'apple-mobile-web-app-capable', - content: 'yes' - }], - ['meta', { - name: 'apple-mobile-web-app-status-bar-style', - content: 'black' - }], - ["link", { - rel: "'stylesheet", - href: "/styles/website.css" - },] - ], - base: '/', - dest: './docs', - - watch: { - $page(newPage, oldPage) { - if (newPage.key !== oldPage.key) { - requestAnimationFrame(() => { - if (this.$route.hash) { - const element = document.getElementById(this.$route.hash.slice(1)); - - if (element && element.scrollIntoView) { - element.scrollIntoView(); - } - } - }); - } - } - }, - - markdown: { - extendMarkdown: md => { - md.use(require('markdown-it-multimd-table'), { - rowspan: true, - }); - } - }, - - theme: 'vuepress-theme-succinct', - globalUIComponents: [ - 'ThemeManager' - ], - - themeConfig: { - lastUpdated: true, - repo: 'https://github.com/PojavLauncherTeam/PojavLauncherTeam.github.io/', - docsDir: '', - docsBranch: 'lunaveux-patch-1', - editLinks: true, - editLinkText: 'Help us improve this page!', - logo: 'logo.png', - - sidebar: [ - { - title: 'Wiki', // Category for information - collapsable: false, - - children: [ - { - title: 'Getting Started', // Subcategory for starting off. - collapsable: false, // Don't allow collapsing. - sidebarDepth: 1, - children: [ - 'INSTALL', // Installing PojavLauncher. - 'BUILD-FROM-SOURCE', // Building PojavLauncher from source. - 'SIGN-IN', // Signing in. - 'INSTALL-MC', // Downloading Minecraft. - 'CUSTOM-CONTROLS', // Customizing the on-screen controls. - 'SOCIALMEDIA', // Official PojavLauncher social medias. - ] - }, - { - title: 'Frequently Asked Questions', // Subcategory for FAQ. - collapsable: true, - sidebarDepth: 1, - children: [ - // FAQ that applies to both platforms goes here - 'INSTALLATIONOFMODSRPWORLDS', // Installation of mods, resource packs, worlds in their correct form. - 'CRASHES', // Random crashes during gameplay. - 'MODCONFLICT', // I have a mod conflict. - 'JAVAVERSION', // Which Java version to use? - 'CANTLOGIN', // Can't log in. - { - title: 'Android-specific', // Subcategory for Android FAQ. - collapsable: true, // Allow collapsing. - sidebarDepth: 1, - children: [ - 'PARSINGERROR', // "Error while parsing the package" error fix. - 'REFUSALOFINSTALL', // "App not installed" error fix (very uncommon). - 'CANTFINDLOG', // Can't find the log file (non-root). - 'CANTFINDMINECRAFT', // Can't find .minecraft (non-root). - 'ZINKNOTWORKING', // Zink doesn't work. - 'MODCRASHING', // Installing any mod results in a crash. - 'MODNOTSHOWINGUP', // My mods don't show up in-game. - 'JAVARUNTIMES', // Installing Java runtimes manually. - 'JARCRASHED', // Crash when executing a jar. - '32BIT', // Platform and performance limitations (32bit). - 'FFMPEG', // Setting up FFMPEG, for Replay Mod. - 'SHADERS', // Look what we got here. - 'RENDERERS', // I have no idea what they do and why PojavLauncher needs it. - ] - }, - { - title: 'iOS-specific', // Subcategory for iOS FAQ. - collapsable: true, // Allow collapsing. - sidebarDepth: 1, - children: [ - 'JIT', // iOS and "JIT". - 'APPSTORE', // Will PojavLauncher ever come to App Store for iOS? - ] - }, - ] - }, - { - title: 'Going further', // Subcategory for getting deeper in the launcher. - collapsable: true, - sidebarDepth: 1, - children: [ - 'OPTIMIZATION', // Optimizing the game. - 'CUSTOM-MC', // Custom Minecraft! - 'MODPACKS', // Everything you need to know about Modpacks support. - 'PROBLEMATIC-MODS-COMMON-FIXES', // List of available fixes for popular modpacks. - 'ENV-VARS', // Using environment variables. - 'JAVA-ARGS', // Adding custom Java arguments. - ] - - }, - - ] - - }, - { - title: 'About PojavLauncher', // Category about the project. - collapsable: false, - sidebarDepth: 1, - children: [ - 'LEGAL', // Legal + Security. - 'DEVICES', // Supported Devices. - 'MCVERS', // Supported Minecraft Versions. - 'MODS-UNSUPPORTED', // Unsupported Mods. - ] - - }, - { - title: 'Contributing', // Category about contributing. - collapsable: false, - sidebarDepth: 1, - children: [ - 'CONT-WEBSITE', // Contributing to this website. - 'CONT-TRANSLATIONS', //Contributing to PojavLauncher translations, hopefully website translations later on. - ] - - }, - { - title: 'Recent Updates', // Category about recent developments. - collapsable: false, - sidebarDepth: 1, - children: [ - 'UNJAIL', // Bringing PojavLauncher to unjailbroken iOS. - 'IOS-SUPPORT', // System support in future versions of PojavLauncher iOS. - 'LOCAL-MODE', // Offline mode is going places. - ] - - }, - ], - }, - plugins: [ - ['vuepress-plugin-code-copy', true], - ['flexsearch'], - ['code-switcher'], - '@vuepress/plugin-back-to-top', - 'vuepress-plugin-smooth-scroll', - ['vuepress-plugin-medium-zoom', - { - selector: "img", - options: { - background: 'var(--bodyBgColor)' - } - }], - ] -} diff --git a/markdown/.vuepress/README.md b/markdown/.vuepress/README.md index 249d2c01..a8e77445 100644 --- a/markdown/.vuepress/README.md +++ b/markdown/.vuepress/README.md @@ -39,16 +39,4 @@ https://github.com/alexytomi/PojavlauncherWikiTesting/blob/7fa1deef1ff2623776110 These still follow the rules that Getting_Started and Going_Further have. They're just put as children of FAQ instead of being their own group. -### Markdown Files Summary - -#### Getting Started -- INSTALL - Installing PojavLauncher -- BUILD-FROM-SOURCE - Building PojavLauncher from source -- SIGN-IN - Signing in -- INSTALL-MC - Downloading Minecraft -- CUSTOM-CONTROLS - Customizing the on-screen controls -- DISCORD - Official PojavLauncher Discord server - -WIP. Documenting this would be documenting stale files. Awaiting PR review. - diff --git a/markdown/.vuepress/arrays.js b/markdown/.vuepress/arrays.js index d2dc8482..1c303c3a 100644 --- a/markdown/.vuepress/arrays.js +++ b/markdown/.vuepress/arrays.js @@ -1,22 +1,22 @@ // Sidebar Arrays const android_FAQ = { title: 'Android-specific', // Subgroup for Android FAQ - collapsable: true, sidebarDepth: 1, + collapsable: true, sidebarDepth: 1, path: 'android', // Do not add a trailing slash here unless this also has a child nested in it with its own path children: [ - 'PARSINGERROR', - 'REFUSALOFINSTALL', - 'CANTFINDLOG', - 'CANTFINDMINECRAFT', - 'ZINKNOTWORKING', - 'MODCRASHING', - 'MODNOTSHOWINGUP', - 'JAVARUNTIMES', - 'JARCRASHED', - '32BIT', - 'FFMPEG', - 'SHADERS', - 'RENDERERS', + 'PARSINGERROR', // "Error while parsing the package" error fix. + 'REFUSALOFINSTALL', // "App not installed" error fix (very uncommon). + 'CANTFINDLOG', // Can't find the log file (non-root). + 'CANTFINDMINECRAFT', // Can't find .minecraft (non-root). + 'ZINKNOTWORKING', // Zink doesn't work. + 'MODCRASHING', // Installing any mod results in a crash. + 'MODNOTSHOWINGUP', // My mods don't show up in-game. + 'JAVARUNTIMES', // Installing Java runtimes manually. + 'JARCRASHED', // Crash when executing a jar. + '32BIT', // Platform and performance limitations (32bit). + 'FFMPEG', // Setting up FFMPEG, for Replay Mod. + 'SHADERS', // Look what we got here. + 'RENDERERS', // I have no idea what they do and why PojavLauncher needs it. ] } @@ -26,8 +26,8 @@ const ios_FAQ = { sidebarDepth: 1, path: 'ios', // Do not add a trailing slash here unless this also has a child nested in it with its own path children: [ - 'JIT', - 'APPSTORE', + 'JIT', // iOS and "JIT". + 'APPSTORE', // Will PojavLauncher ever come to App Store for iOS? ] } @@ -36,14 +36,14 @@ export const FAQ = { collapsable: true, path: '/wiki/faq/', // Trailing slash is required children: [ + 'INSTALLATIONOFMODSRPWORLDS', // Installation of mods, resource packs, worlds in their correct form. + 'CRASHES', // Random crashes during gameplay. + 'MODCONFLICT', // I have a mod conflict. + 'JAVAVERSION', // Which Java version to use? + 'CANTLOGIN', // Can't log in. + // FAQ that applies to both platforms ends here android_FAQ, // Subgroup for Android-specific FAQ. See Above to configure. ios_FAQ, // Subgroup for iOS-specific FAQ. See Above to configure. - // FAQ that applies to both platforms starts here - 'RPWORLDNOTSHOWINGUP', - 'CRASHES', - 'MODCONFLICT', - 'JAVAVERSION', - 'CANTLOGIN', ] } @@ -52,12 +52,12 @@ export const Getting_Started = { path: '/wiki/getting_started/', collapsable: true, children: [ - 'INSTALL', - 'BUILD-FROM-SOURCE', - 'SIGN-IN', - 'INSTALL-MC', - 'CUSTOM-CONTROLS', - 'DISCORD', + 'INSTALL', // Installing PojavLauncher. + 'BUILD-FROM-SOURCE', // Building PojavLauncher from source. + 'SIGN-IN', // Signing in. + 'INSTALL-MC', // Downloading Minecraft. + 'CUSTOM-CONTROLS', // Customizing the on-screen controls. + 'SOCIALMEDIA', // Official PojavLauncher social medias. ], } @@ -66,34 +66,34 @@ export const Going_Further = { path: '/wiki/going_further/', collapsable: true, children: [ - 'OPTIMIZATION', - 'CUSTOM-MC', - 'MODPACKS', - 'PROBLEMATIC-MODS-COMMON-FIXES', - 'ENV-VARS', - 'JAVA-ARGS', + 'OPTIMIZATION', // Optimizing the game. + 'CUSTOM-MC', // Custom Minecraft! + 'MODPACKS', // Everything you need to know about Modpacks support. + 'PROBLEMATIC-MODS-COMMON-FIXES', // List of available fixes for popular modpacks. + 'ENV-VARS', // Using environment variables. + 'JAVA-ARGS', // Adding custom Java arguments. ] } -// These are used to change the sidebar of their corresponding navbar counterpart. These don't use sidebar groups, instead they use the header as the title of the sidebar group (see Vuepress Documentation for more information on this behaviour). These sections are simple enough to not need custom shenanigans. +//// These are used to change the sidebar of their corresponding navbar counterpart. These don't use sidebar groups, instead they use the header as the title of the sidebar group (see Vuepress Documentation for more information on this behaviour). These sections are simple enough to not need custom shenanigans. -export const contribute = [ - 'CONT-WEBSITE', - 'CONT-TRANSLATIONS', +export const about = [ + 'LEGAL', // Legal + Security. + 'DEVICES', // Supported Devices. + 'MCVERS', // Supported Minecraft Versions. + 'MODS-UNSUPPORTED', // Unsupported Mods. ] -export const about = [ - 'LEGAL', - 'DEVICES', - 'MCVERS', - 'MODS-UNSUPPORTED', +export const contribute = [ + 'CONT-WEBSITE', // Contributing to this website. + 'CONT-TRANSLATIONS', // Contributing to PojavLauncher translations, hopefully website translations later on. ] export const patchnotes = [ - 'UNJAIL', - 'IOS-SUPPORT', - 'LOCAL-MODE', + 'UNJAIL', // Bringing PojavLauncher to unjailbroken iOS. + 'IOS-SUPPORT', // System support in future versions of PojavLauncher iOS. + 'LOCAL-MODE', // Offline mode is going places. ] // Configuration Arrays @@ -101,13 +101,13 @@ export const patchnotes = [ export const GroupOrder = [ // This defines how groups are ordered within specific paths. So far, only the /wiki/ path uses this as it is the only path with sidebar groups. [ // /wiki/ - 'Getting_Started','Going_Further','FAQ' + 'Getting_Started', 'FAQ', 'Going_Further' ], [ // Unused - 'contribute' + 'about' ], [ // Unused - 'about' + 'contribute' ], [ // Unused 'patchnotes' @@ -117,8 +117,8 @@ export const GroupOrder = [ // This is just the regular nav configuration but it's in here instead of config.js because it makes more sense that way. export const NavBar = [ { text: 'Wiki', link: '/wiki/' }, - { text: 'Contributing', link: '/contribute/CONT-TRANSLATIONS' }, { text: 'About Pojavlauncher', link: '/about/DEVICES' }, + { text: 'Contributing', link: '/contribute/CONT-TRANSLATIONS' }, { text: 'Recent Updates', link: '/patchnotes/IOS-SUPPORT' }, ] diff --git a/markdown/.vuepress/bars.js b/markdown/.vuepress/bars.js index 4730d524..a9c6a446 100644 --- a/markdown/.vuepress/bars.js +++ b/markdown/.vuepress/bars.js @@ -4,15 +4,15 @@ const { GroupOrder } = Arrays; // Disgusting spam but readable const WikiSideBar = (GroupOrder[0]).map(category => generateSideBar(Arrays[category])); // Uses GroupOrder to generate wiki sidebar -const ContributeSideBar = (require('./arrays.js').contribute); // Just use page headers for sidebar -const AboutSideBar = (require('./arrays.js').about); +const AboutSideBar = (require('./arrays.js').about); // Just use page headers for sidebar +const ContributeSideBar = (require('./arrays.js').contribute); const PatchSideBar = (require('./arrays.js').patchnotes); // Defines path specified sidebars const SideBar = { '/wiki/': WikiSideBar, + '/about/': AboutSideBar, '/contribute/': ContributeSideBar, - '/about/': AboutSideBar, '/patchnotes/': PatchSideBar, } diff --git a/markdown/.vuepress/config.js b/markdown/.vuepress/config.js index 4dcf3098..99a840e8 100644 --- a/markdown/.vuepress/config.js +++ b/markdown/.vuepress/config.js @@ -82,7 +82,7 @@ module.exports = { lastUpdated: true, repo: "https://github.com/PojavLauncherTeam/PojavLauncherTeam.github.io/", docsDir: "", - docsBranch: "lunaveux-patch-1", + docsBranch: "main", editLinks: true, editLinkText: "Help us improve this page!", logo: "/logo.png", diff --git a/changelogs/ANDROID.md b/markdown/changelogs/ANDROID.md similarity index 100% rename from changelogs/ANDROID.md rename to markdown/changelogs/ANDROID.md diff --git a/changelogs/IOS.md b/markdown/changelogs/IOS.md similarity index 100% rename from changelogs/IOS.md rename to markdown/changelogs/IOS.md diff --git a/INSTALLATIONOFMODSRPWORLDS.md b/markdown/wiki/faq/INSTALLATIONOFMODSRPWORLDS.md similarity index 100% rename from INSTALLATIONOFMODSRPWORLDS.md rename to markdown/wiki/faq/INSTALLATIONOFMODSRPWORLDS.md diff --git a/markdown/wiki/faq/RPWORLDNOTSHOWINGUP.md b/markdown/wiki/faq/RPWORLDNOTSHOWINGUP.md deleted file mode 100644 index bbfd171d..00000000 --- a/markdown/wiki/faq/RPWORLDNOTSHOWINGUP.md +++ /dev/null @@ -1,21 +0,0 @@ -# Resource pack or world doesn't show up -Read carefully and check the structure of the archives (zips) or folders (directories), make sure there are no additional ones. - -## Resource pack -**Wrong:** -pack.zip → pack (folder) → pack.mcmeta -pack (folder) → pack (folder) → pack.mcmeta - -**Correct:** -pack.zip → pack.mcmeta -pack (folder) → pack.mcmeta - -## World -The world cannot be zipped inside the saves folder. - -**Wrong:** - world.zip → level.dat - world.zip → world (directory) → level.dat - -**Correct:** - world (directory) → level.dat diff --git a/markdown/wiki/getting_started/DISCORD.md b/markdown/wiki/getting_started/DISCORD.md deleted file mode 100644 index 1699141a..00000000 --- a/markdown/wiki/getting_started/DISCORD.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -next: ../going_further/OPTIMIZATION.md ---- - -# Official PojavLauncher Discord server - -The only official invite for the PojavLauncher server, beware of invites created by other users. -[invite link](https://discord.gg/pojavlauncher-724163890803638273) - -NOTE: A Minecraft account is **REQUIRED** in order for you to be able to seek PojavLauncher-based support in the server. - - diff --git a/SOCIALMEDIA.md b/markdown/wiki/getting_started/SOCIALMEDIA.md similarity index 100% rename from SOCIALMEDIA.md rename to markdown/wiki/getting_started/SOCIALMEDIA.md