Helios Launcher Documentation

website·Indexed 30 days ago

https://docs.geekcorner.eu.org

Unofficial documentation for the customization and development of the Helios Launcher. Includes guides on modifying the home screen, managing social network links, editing translation files such as app/landing.ejs, and managing Mojang and server statuses. Requires basic knowledge of Node.JS.

Tokens
5.8K
Snippets
34
Records
52
Agent score
49%

What's inside Helios Launcher

  1. Test launcher modifications locally

    After making changes to assets or code, you can test the launcher by running the start command using your preferred package manager (npm, Yarn, or pnpm).
    npm start
  2. Translate the Helios landing page

    To translate the landing page, modify the text content within the app/landing.ejs file. Key elements to translate include the server status label, player count status, Mojang status labels, news button text, and launch button labels.
    <!-- Example translations in app/landing.ejs -->
    <span class="bot_label" id="landingPlayerLabel">SERVEUR</span>
    <span id="player_count">HORS-LIGNE</span>
    <span class="bot_label">STATUS MOJANG</span>
    <span id="newsButtonText">ACTUALITÉS</span>
    <button id="launch_button">JOUER</button>
    <button id="server_selection_button" class="bot_label">&#8226; Aucun serveur sélectionné</button>
    <span id="launch_details_text" class="bot_label">Patientez...</span>
    <span id="newsNavigationStatus">1 sur 1</span>
  3. Test and deploy landing page modifications

    To test your changes locally, run the start command using your preferred package manager (npm, Yarn, or pnpm). Once verified, use GitHub Desktop to commit your changes to the master branch and push them to the origin repository.
    npm start
  4. Prerequisites for customizing Helios Launcher

    To customize the Helios Launcher, you will need the following prerequisites:

    • Basic knowledge of Node.js
    • A web server (a CMS like Azuriom is recommended)
    • A GitHub account
  5. Translate the Helios Launcher landing page

    To translate the landing page, modify the text content within the app/landing.ejs file. Locate the specific HTML elements by their IDs and update the inner text to the desired language.
    <!-- Example: Translating 'Update Available' to French -->
    <div id="updateAvailableTooltip">Une mise à jour est diponible</div>
    
    <!-- Example: Translating 'Username' to French -->
    <span id="user_text">Nom d'utilisateur</span>
    
    <!-- Example: Translating 'Edit' to French -->
    <button id="avatarOverlay">Modifier</button>
    
    <!-- Example: Translating 'Settings' to French -->
    <div id="settingsTooltip">Paramètres</div>
  6. Change the launcher loading logo

    To change the loading screen images, navigate to the app/assets/images directory in your repository. Replace the existing files with your own images. Ensure images are in a square format to avoid design issues.

    • LoadingSeal.png: The static background image.
    • LoadingText.png: The image that rotates.
  7. Test and deploy landing page changes

    To verify modifications to the landing page, run the project locally using npm start. Once verified, use GitHub Desktop to commit the changes to the master branch and push them to the origin repository.
    npm start
  8. Change the launcher loading logo

    To change the loading screen images, navigate to the app/assets/images directory in your project folder. Replace the following files with your own images. Ensure the images are square to prevent design issues in the launcher.

    • LoadingSeal.png: The static background image.
    • LoadingText.png: The image that rotates.
  9. Translate the Helios home page

    To translate the home page, modify the text content within the app/landing.ejs file. Locate the specific HTML elements by their IDs and update the inner text to the desired language. Key elements for translation include server status labels, Mojang status headers, news buttons, and launch buttons.
    <!-- Example: Translating Server Status -->
    <span class="bot_label" id="landingPlayerLabel">SERVEUR</span>
    <span id="player_count">HORS-LIGNE</span>
    
    <!-- Example: Translating Mojang Status -->
    <span class="bot_label">STATUS MOJANG</span>
    
    <!-- Example: Translating News Button -->
    <span id="newsButtonText">ACTUALITÉS</span>
    
    <!-- Example: Translating Launch Button -->
    <button id="launch_button">JOUER</button>
  10. Customize the launcher name and UI text

    To change the visible name of the launcher and the welcome screen text, modify the following EJS files:

    • Window Title: Edit app/frame.ejs (around line 16) and update the text inside <span id="frameTitleText">.
    • Browser/App Title: Edit app/app.ejs and update the text inside the <title> tag.
    • Welcome Page: Edit app/welcome.ejs to change the welcomeHeader, welcomeDescription, and welcomeDescCTA spans.
  11. Push Helios Launcher changes to GitHub using GitHub Desktop

    To save and upload your modifications to your GitHub fork using GitHub Desktop:

    1. Enter a description of your changes in the commit form (bottom left).
    2. Click Commit to master.
    3. Click Push origin at the top of the interface to upload the changes to the remote repository.