Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DuckyHQ0/hqlauncher
A Minecraft launcher, with modern UI, and modern features.
https://github.com/DuckyHQ0/hqlauncher
electron launcher minecraft nextjs react typescript
Last synced: 3 months ago
JSON representation
A Minecraft launcher, with modern UI, and modern features.
- Host: GitHub
- URL: https://github.com/DuckyHQ0/hqlauncher
- Owner: DuckyHQ0
- License: gpl-3.0
- Created: 2023-07-21T21:35:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-23T04:56:33.000Z (7 months ago)
- Last Synced: 2024-05-23T05:41:10.900Z (7 months ago)
- Topics: electron, launcher, minecraft, nextjs, react, typescript
- Language: TypeScript
- Homepage: https://hql.duckyhq.com
- Size: 37.5 MB
- Stars: 53
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# HQLauncher
## Version 0.2 Alpha
[](https://discord.gg/MeQwqsCHUE)
## 📗 About
HQLauncher is a Minecraft launcher, with modern UI.
It aims to include many useful features such as:
- Instance management
- Creation of vanilla, and modded instances
- Download mod-packs & mods straight from the launcher
- Easy to use and secure account manager, with easy skin management
- Mod, shader-pack and resource-pack management inside instances
- And more!
Please report any bugs inside the issues tab under this repository, or inside my [Discord](https://discord.gg/MeQwqsCHUE). I'm also open to suggestions!
## 🏃♂️ How to Run (dev)
- Install node.js
- Download the source code (Git clone, GitHub desktop, or download zip)
- Open the directory, and run:
```bash
npm install
npm run dev
```
## 📁 Project Info
### Technologies
Big thanks to the author and contributors of [MSMC](https://github.com/Hanro50/MSMC) and [GMLL](https://github.com/Hanro50/GMLL), for making authentication and launcher stuff so easy.
This project is built with Nextron (next.js and electron)
It uses [MorphUI](https://github.com/DuckyHQ0/morphui) (also a duckyhq project) for the design. MorphUI uses Radix Primitives for components, and this entire project uses Tailwind CSS.
### Directory Structure (simplified)
The main process's files are inside the main directory, same with the renderer process. The main process is like the back-end of the app, for electron, system, and launcher stuff. The renderer is what you see, so it's the front-end. These are the only two folders you should be mainly working in.
When you init GMLL, a `.minecraft` folder will be created containing all the important launcher stuff.
```
├── .minecraft
├── main/
│ ├── launcher/
│ │ ├── auth.ts - Authentication
│ │ └── launcher.ts - Minecraft launching stuff
│ ├── background.ts - Main Electron file
│ └── preload.ts - IPC stuff
└── renderer/
├── components/ - MorphUI components, and specific HQL components (including layouts)
├── pages/ - All the front-end pages
└── public/ - Assets
```
## ⬆️ Contributing & License
Feel free to contribute to the development of this project. Any help is appreciated!
All code and media in this repository is licensed under the [GNU General Public License v3.0](/LICENSE.txt).
## 🎨 Brand
Brand assets are available [here](https://github.com/DuckyHQ0/hqlauncher/tree/main/renderer/public/brand).
This project can be named by `HQLauncher` or `HQL`.
Do not claim HQLauncher to be yours.
Do not alter the logo or use it for your own projects.