-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/Jax-Core/ValliStart
- Loading branch information
Showing
2 changed files
with
83 additions
and
145 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| name: "📄 Dynamic ReadME" | ||
|
|
||
| env: | ||
| VS_WORKFLOW_TYPE: "dynamic-readme" | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - README.md | ||
|
|
||
| jobs: | ||
| update_readme: | ||
| name: "Render & Update ReadME" | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: "📥 Fetching Repository Contents" | ||
| uses: actions/checkout@main | ||
|
|
||
| - name: "💾 Github Repository Metadata" | ||
| uses: varunsridharan/action-repository-meta@main | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: "💫 Update README.md" | ||
| uses: "varunsridharan/action-dynamic-readme@main" | ||
| with: | ||
| GLOBAL_TEMPLATE_REPOSITORY: Jax-Core/ReadME-Template/Templates | ||
| commit_message: ⏩ File Rebuilt by Github Actions - Dynamic ReadME | ||
| files: | | ||
| README.md | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,188 +1,91 @@ | ||
| <div id="top"></div> | ||
|
|
||
| <!-- START Header.mustache --> | ||
| <br /> | ||
| <div align="center"> | ||
| <a href="https://github.com/Jax-Core/ValliStart"> | ||
| <img src="https://cdn.discordapp.com/attachments/875630623853793283/977856719055114250/ValliStart3.png" alt="Logo" width="200" height="200"> | ||
| <img src="https://raw.githubusercontent.com/Jax-Core/ReadME-Template/main/Resources/Icons/ValliStart.png" alt="Logo" width="180" height="180"> | ||
| </a> | ||
| <h3 align="center">ValliStart</h3> | ||
|
|
||
| <h3 align="center">ValliStart</h3> | ||
| <p align="center"> | ||
| A custom start menu to replace the default one. | ||
| <br /> | ||
| <a href="https://www.deviantart.com/jaxoriginals/art/ ValliStart-Start-menu-replacement-893506095"><strong>More Info »</strong> | ||
| </a> | ||
| <br /> | ||
| A start menu to replace the un-customizable one that you have right now. | ||
| <br /> | ||
| <a href="https://discord.gg/JmgehPSDD6">Report Bugs & Request Features</a> | ||
| <a href="https://discord.gg/JmgehPSDD6">Help, Report Bugs & Request Features »</a> | ||
| </p> | ||
| </div> | ||
|
|
||
| <!-- END Header.mustache --> | ||
| <!-- START ShieldsFull.mustache --> | ||
| <p align="center"> | ||
| <img alt="Latest by date" src="https://img.shields.io/github/v/tag/Jax-Core/ValliStart?label=Version&style=for-the-badge" /> | ||
| <img alt="Releases" src="https://img.shields.io/github/downloads/Jax-Core/ValliStart/total?style=for-the-badge" /> | ||
| <img alt="Release date" src="https://img.shields.io/github/release-date/Jax-Core/ValliStart?label=Last%20Update&style=for-the-badge" /> | ||
| <img alt="Discord" src="https://img.shields.io/discord/880445067754610688?label=Discord%20server&style=for-the-badge" /> | ||
| <img alt="Github" src="https://img.shields.io/github/license/Jax-Core/ValliStart?style=for-the-badge" /> | ||
|
|
||
| </p> | ||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| <details> | ||
| <summary>Table of Contents</summary> | ||
| <ol> | ||
| <li> | ||
| <a href="#about">About</a> | ||
| </li> | ||
| <li> | ||
| <a href="#Features">Features</a> | ||
| </li> | ||
| <li> | ||
| <a href="#getting-started">Getting Started</a> | ||
| <ul> | ||
| <li><a href="#prerequisites">Prerequisites</a></li> | ||
| <li><a href="#installation">Installation</a></li> | ||
| <li> <a href="#customization">Customization</a></li> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| <a href="#modules-setup">Modules Setup</a> | ||
| <ul> | ||
| <li><a href="#pinned-shortcuts">Pinned Shortcuts</a></li> | ||
| <li><a href="#weather">Weather</a></li> | ||
| <li><a href="#media-controls">Media Controls</a> | ||
| <ul> | ||
| <li><a href="#for-spotify">Spotify</a></li> | ||
| <li><a href="#for-web-players">Web Players</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li> <a href="#help-and-credits">Help & Credits</a></li> | ||
| </ol> | ||
| </details> | ||
|
|
||
| <!-- ABOUT THE PROJECT --> | ||
| </p><!-- END ShieldsFull.mustache --> | ||
|
|
||
| <!-- START About.mustache --> | ||
|
|
||
| ## About | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ValliStart is a start menu replacement for Windows, with full customizability, interchangeable modules and more. | ||
| <!-- END About.mustache --> | ||
| **ValliStart** is a start menu replacement for Windows, with full customizability, interchangeable modules and more. | ||
|
|
||
| ## Features | ||
| <!-- START Features.mustache --> | ||
|
|
||
| ## Features<!-- END Features.mustache --> | ||
| * Flawless Animations | ||
| * Full-fledged Control Center | ||
| * Custom Pinned Shortcuts | ||
| * Intergrated Media Controls | ||
| * Customizable Hotkeys | ||
| * Additional Modules like Weather Status | ||
|
|
||
| <p align="right"> | ||
| <b><a href="#top">↥ back to top</a></b> | ||
| </p> | ||
| <!-- START GetStarted.mustache --> | ||
|
|
||
| <!-- INSTALLATION AND SETUP --> | ||
| ## Getting Started | ||
|
|
||
| ### Prerequisites | ||
| - **Windows 10** or above | ||
| - For older systems, **Powershell v5.1 or newer** is required. Upgrade powershell **[here](https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/install/installing-windows-powershell?view=powershell-7.2#upgrading-existing-windows-powershell)**! | ||
| > For older systems, **Powershell v5.1 or newer** is required. Upgrade powershell **[here](https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/install/installing-windows-powershell?view=powershell-7.2#upgrading-existing-windows-powershell)**! | ||
| ### Installation | ||
| **By Powershell CLI:** | ||
| Run the following command in Powershell (`win + r` -> `powershell.exe` / search) | ||
| ``` | ||
| $installSkin="ValliStart";Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/Jax-Core/JaxCore/master/CoreInstaller.ps1" | Invoke-Expression | ||
| ``` | ||
| **By legacy [Rainmeter](https://www.rainmeter.net/) .rmskin installer:** | ||
| Download and run the `.rmskin` file from the latest release **[here](https://github.com/Jax-Core/ValliStart/releases/latest)**. | ||
| > Note: If you find that the JaxCore option is red on the startup pop-up, please press the red button and Core will be installed automatically. Perchance this fails, you can manually install Core by downloading the `.rmskin` file from [JaxCore's official website.](https://jax-core.github.io/) | ||
| <br /> | ||
| <br /> | ||
| ## Customization | ||
|
|
||
| ValliStart includes 6 color scheme presets. You enable them by just selecting them within the **Color Scheme** tab. | ||
| Furthermore, ValliStart also comes with 4 layout presets. You can enable them by just selecting them within the **Layout** tab: | ||
|
|
||
|  | ||
|
|
||
| ## Activation | ||
| ValliStart can be activated in multiple ways: | ||
| #### Replacing the native windows button and key | ||
| You can launch ValliStart just like the start menu with the `Win` Key. Additionally, you can replace the windows button by: | ||
| - Creating a pseudo start button with core | ||
| 1. Navigate to `JaxCore -> ValliStart -> General -> Setting: Customize how to activate ValliStart` and turn on override start button. | ||
| 2. Select a start orb name. The default is `Win11`. You can choose another one / add your own one in the orbs directory, and entering another start orb name. | ||
| 3. Press the `Create` button above | ||
| 4. Core should popup the explorer with shortcut `ValliStart.lnk` inside | ||
| 5. Drag the shortcut to the taskbar | ||
| 6. Now you have a pseudo start button on the taskbar! | ||
| 7. If you want to remove the stock start button: You can use [StartKiller](http://www.startkiller.com/) for Win10. There are no known ways of doing so on Windows 11. | ||
|
|
||
| - Using ValliStart's winblock function to create an overlay which overlaps the start button on your taskbar | ||
| 1. Navigate to `JaxCore -> ValliStart -> General -> Setting: Customize how to activate ValliStart` and turn on override start button. | ||
| 2. Toggle `Setting: Display WinBlock element (legacy)` on | ||
| 3. Switch `Setting: Win block behavior` to edit | ||
| 4. Drag the winblocker to desired location | ||
| 5. Switch `Setting: Win block behavior` to functional | ||
| Run the following command in Powershell to download the latest version of JaxCore. | ||
|
|
||
| #### Using a separate hotkey | ||
| You can also launch ValliStart with the hotkey of your choice. This does not support overriding the displayed window button on your taskbar. | ||
| 1. Navigate to `JaxCore -> ValliStart -> General -> Setting: How should ValliStart behave?` and switch the option to `Separate module` | ||
| 2. Change `Setting: Activation Hotkey`to your desired hotkey | ||
| (To launch Powershell as an Admin: `Win + R` -> `powershell` -> Press `CTRL + SHIFT + ENTER` on your keyboard. Powershell can also be launched via Windows Search.) | ||
|
|
||
| <p align="right"> | ||
| <b><a href="#top">↥ back to top</a></b> | ||
| </p> | ||
|
|
||
| <!-- MODULES SETUP --> | ||
| # Modules Setup | ||
|
|
||
| Now that you've installed and setup ValliStart, let's begin setting up some modules it comes with! | ||
|
|
||
| ## Pinned Shortcuts | ||
|
|
||
| ### Choosing a module preset | ||
|
|
||
| If your ValliStart layout preset does not have the pinned shortcuts module enabled by default, follow the steps outlined below to enable it. However, if it is already enabled/selected, you can skip to configuring it. | ||
|
|
||
| 1. Open Core and head over to the **Modules** section. | ||
| 2. Select **ValliStart** from the list and proceed to the **Modules** tab. | ||
| 3. Scroll all way to the bottom, find the module labelled **None** and click `Change`. Alternatively, you can also replace any other pre-existing module with the shortcut module. | ||
| 4. Go to the **Shortcut Modules** tab and select a preset you like. You can choose from three presets; **WinRow11**, **DoubleRow**, and **SingleRow**. | ||
| > <img src ="https://imgur.com/JgHZTni.png" alt = "ref" width="378" height ="80"> | ||
| ### Configuring the preset | ||
|
|
||
| 1. Open Core and head over to the **Modules** section. | ||
| 2. Select **ValliStart** from the list and proceed to the **Modules** tab. | ||
| 3. Open the settings for your currently enabled shortcuts module. | ||
| 4. Click on one of the pre-existing shortcut's name. | ||
| 5. Select the shortcut for the application to be pinned. | ||
|
|
||
| That's all there is to it. Your shortcuts will now be visible in the pinned applications section. | ||
|
|
||
| ## Weather | ||
| ``` | ||
| Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/Jax-Core/JaxCore/master/CoreInstaller.ps1" | Invoke-Expression | ||
| ``` | ||
|
|
||
| 1. Open Core and head over to the **Modules** section. | ||
| 2. Select **ValliStart** from the list and proceed to the **Modules** tab. | ||
| 3. Open the settings for the **Weather** module. | ||
| 4. Click the green redirect button next to the `Configure weather settings in core's global settings` text. | ||
| > <img src ="https://imgur.com/WDatjK5.png" alt = "ref" width="755" height ="81"> | ||
| > Alternatively you can download it from the [website](https://jax-core.github.io/) | ||
| 5. Once the **Global Variables** configuration window opens, change the weather location to the location you want the weather status of. | ||
| > <img src ="https://imgur.com/ycI4Qp4.png" alt = "ref" width="867" height ="55"> | ||
| 6. Refresh ValliStart by deactivating and activating again using the toggle on the bottom left. | ||
| After you've proceeded through the welcome screen, select `ValliStart` (might have to scroll down) and click `Install`. It will appear in the library page after that. | ||
| <br /> | ||
| <br /><!-- END GetStarted.mustache --> | ||
| <!-- START Setup.mustache --> | ||
|
|
||
| > **Note:** You can also alter other options like the temperature unit, the language the weather is shown in, and the time format when configuring the weather location on **Step 5**. Also, **if you're not sure what the API key is for, don't change or edit it.** | ||
| ### Configuration | ||
| Use the JaxCore menu to configure ValliStart. | ||
| For more information, visit [JaxCore's documentation](https://jaxcore.gitbook.io/core/) | ||
| <br> | ||
| <br><!-- END Setup.mustache --> | ||
| <!-- START Footer.mustache --> | ||
|
|
||
| # Help and Credits | ||
| ## Need assistance? | ||
| * Join the [CoreCommunity Discord Server](https://discord.gg/JmgehPSDD6) for help | ||
| * or [Create an issue](https://github.com/Jax-Core/ValliStart) | ||
|
|
||
| * Spicetify installation guide by [khanhas](https://github.com/khanhas). | ||
| ## Say Hi! | ||
| * Follow me on 👨💻 [Github](https://github.com/EnhancedJax) and stay updated on new things that I make | ||
| * You can also watch me on 🐦 [DeviantArt](https://www.deviantart.com/jaxoriginals) instead | ||
| * Message me on 🗨️ [Discord](https://discord.gg/JmgehPSDD6) | ||
|
|
||
| * Join the [Core Community Discord Server](https://discord.gg/JmgehPSDD6) for more help. | ||
| --- | ||
|
|
||
| <p align="right"> | ||
| <b><a href="#top">↥ back to top</a></b> | ||
| </p> | ||
| <p align="center"> | ||
| <i>Made with ❤️ by Jax</i> | ||
| <br/><br/> | ||
| <img src="https://raw.githubusercontent.com/Jax-Core/ReadME-Template/main/Resources/Assets/Logo.png" width="32" height="32"/> | ||
| </p><!-- END Footer.mustache --> |