Update README.md
This commit is contained in:
Yoann Brigant
GitHub
parent
38ab7aa91e
commit
d2496f2214
126
README.md
126
README.md
@ -4,133 +4,25 @@
|
|||||||
|
|
||||||
<em><h5 align="center">(formerly Electron Launcher)</h5></em>
|
<em><h5 align="center">(formerly Electron Launcher)</h5></em>
|
||||||
|
|
||||||
[<p align="center"><img src="https://img.shields.io/github/workflow/status/ElBrigos/TabernaLauncher/Build.svg?style=for-the-badge" alt="gh actions">](https://github.com/ElBrigos/TabernaLauncher/actions) [<img src="https://img.shields.io/github/downloads/ElBrigos/TabernaLauncher/total.svg?style=for-the-badge" alt="downloads">](https://github.com/ElBrigos/TabernaLauncher/releases) <img src="https://el-taberna.com/assets/images/taberna-launcher.svg" height="28px" alt="Taberna-Launcher"></p>
|
[<p align="center"><img src="https://img.shields.io/github/workflow/status/ElBrigos/TabernaLauncher/Build.svg?style=for-the-badge" alt="gh actions">](https://github.com/ElBrigos/TabernaLauncher/actions) [<img src="https://img.shields.io/github/downloads/ElBrigos/TabernaLauncher/total.svg?style=for-the-badge" alt="downloads">](https://github.com/ElBrigos/TabernaLauncher/releases) <img src="https://el-taberna.com/assets/images/taberna-launcher-badge.svg" height="28px" alt="Taberna-Launcher"></p>
|
||||||
|
|
||||||
<p align="center">Join modded servers without worrying about installing Java, Forge, or other mods. We'll handle that for you.</p>
|
<p align="center">Join modded servers without worrying about installing Java, Forge, or other mods. We'll handle that for you.</p>
|
||||||
|
|
||||||
## Requirement
|
## Requirement
|
||||||
|
|
||||||
- The ModPack required `3Go` of Ram `Minimum`
|
- The ModPack required `3Go` of Ram `Minimum`
|
||||||
- Java `8` or Newer
|
- Java `17` or Newer
|
||||||
- The last update of Taberna Launcher 6
|
- The last update of Taberna Launcher
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
* 🔒 Full account management.
|
|
||||||
* Add multiple accounts and easily switch between them.
|
|
||||||
* Microsoft (OAuth 2.0) + Mojang (Yggdrasil) authentication fully supported.
|
|
||||||
* Credentials are never stored and transmitted directly to Mojang.
|
|
||||||
* 📂 Efficient asset management.
|
|
||||||
* Receive client updates as soon as we release them.
|
|
||||||
* Files are validated before launch. Corrupt or incorrect files will be redownloaded.
|
|
||||||
* ☕ **Automatic Java validation.**
|
|
||||||
* If you have an incompatible version of Java installed, we'll install the right one *for you*.
|
|
||||||
* You do not need to have Java installed to run the launcher.
|
|
||||||
* 📰 News feed natively built into the launcher.
|
|
||||||
* ⚙️ Intuitive settings management, including a Java control panel.
|
|
||||||
* Supports all of our servers.
|
|
||||||
* Switch between server configurations with ease.
|
|
||||||
* View the player count of the selected server.
|
|
||||||
* Automatic updates. That's right, the launcher updates itself.
|
|
||||||
* View the status of Mojang's services.
|
|
||||||
|
|
||||||
This is not an exhaustive list. Download and install the launcher to gauge all it can do!
|
|
||||||
|
|
||||||
#### Need Help? [Check the wiki.][wiki]
|
|
||||||
|
|
||||||
#### Like the project? Leave a ⭐ star on the repository!
|
#### Like the project? Leave a ⭐ star on the repository!
|
||||||
|
|
||||||
## Downloads
|
## Installation
|
||||||
|
|
||||||
You can download from [GitHub Releases](https://github.com/dscalzi/HeliosLauncher/releases)
|
Download the last update of [Taberna Launcher](https://github.com/ElBrigos/TabernaLauncher/releases/latest).
|
||||||
|
|
||||||
#### Latest Release
|
## Contributing
|
||||||
|
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
||||||
|
|
||||||
[](https://github.com/dscalzi/HeliosLauncher/releases/latest)
|
Please make sure to update tests as appropriate.
|
||||||
|
|
||||||
#### Latest Pre-Release
|
https://taberna6.el-taberna.com/
|
||||||
[](https://github.com/dscalzi/HeliosLauncher/releases)
|
|
||||||
|
|
||||||
**Supported Platforms**
|
|
||||||
|
|
||||||
If you download from the [Releases](https://github.com/dscalzi/HeliosLauncher/releases) tab, select the installer for your system.
|
|
||||||
|
|
||||||
| Platform | File |
|
|
||||||
| -------- | ---- |
|
|
||||||
| Windows x64 | `Helios-Launcher-setup-VERSION.exe` |
|
|
||||||
| macOS x64 | `Helios-Launcher-setup-VERSION-x64.dmg` |
|
|
||||||
| macOS arm64 | `Helios-Launcher-setup-VERSION-arm64.dmg` |
|
|
||||||
| Linux x64 | `Helios-Launcher-setup-VERSION.AppImage` |
|
|
||||||
|
|
||||||
## Console
|
|
||||||
|
|
||||||
To open the console, use the following keybind.
|
|
||||||
|
|
||||||
```console
|
|
||||||
ctrl + shift + i
|
|
||||||
```
|
|
||||||
|
|
||||||
Ensure that you have the console tab selected. Do not paste anything into the console unless you are 100% sure of what it will do. Pasting the wrong thing can expose sensitive information.
|
|
||||||
|
|
||||||
#### Export Output to a File
|
|
||||||
|
|
||||||
If you want to export the console output, simply right click anywhere on the console and click **Save as..**
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
This section details the setup of a basic developmentment environment.
|
|
||||||
|
|
||||||
### Getting Started
|
|
||||||
|
|
||||||
**System Requirements**
|
|
||||||
|
|
||||||
* [Node.js][nodejs] v16
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Clone and Install Dependencies**
|
|
||||||
|
|
||||||
```console
|
|
||||||
> git clone https://github.com/dscalzi/HeliosLauncher.git
|
|
||||||
> cd HeliosLauncher
|
|
||||||
> npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Launch Application**
|
|
||||||
|
|
||||||
```console
|
|
||||||
> npm start
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Build Installers**
|
|
||||||
|
|
||||||
To build for your current platform.
|
|
||||||
|
|
||||||
```console
|
|
||||||
> npm run dist
|
|
||||||
```
|
|
||||||
|
|
||||||
Build for a specific platform.
|
|
||||||
|
|
||||||
| Platform | Command |
|
|
||||||
| ----------- | -------------------- |
|
|
||||||
| Windows x64 | `npm run dist:win` |
|
|
||||||
| macOS | `npm run dist:mac` |
|
|
||||||
| Linux x64 | `npm run dist:linux` |
|
|
||||||
|
|
||||||
Builds for macOS may not work on Windows/Linux and vice-versa.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Visual Studio Code
|
|
||||||
|
|
||||||
All development of the launcher should be done using [Visual Studio Code][vscode].
|
|
||||||
|
|
||||||
Paste the following into `.vscode/launch.json`
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user