https://github.com/redot-experimental/launcher
Launcher for Redot engine to centralize engine version managment
https://github.com/redot-experimental/launcher
electron react redotengine
Last synced: 3 months ago
JSON representation
Launcher for Redot engine to centralize engine version managment
- Host: GitHub
- URL: https://github.com/redot-experimental/launcher
- Owner: Redot-Experimental
- License: mit
- Created: 2024-11-07T06:49:28.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-11-19T15:55:51.000Z (11 months ago)
- Last Synced: 2024-12-03T23:06:25.130Z (10 months ago)
- Topics: electron, react, redotengine
- Language: TypeScript
- Homepage: https://www.redotengine.org/
- Size: 1 MB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[
](https://www.redotengine.org/)
Redot Engine Launcher
The Redot Engine Launcher is a centralized hub designed to streamline your development workflow.
[](https://github.com/hydralauncher/hydra/actions)
[](https://github.com/hydralauncher/hydra/releases)
[](https://sonarcloud.io/summary/new_code?id=Redot-Experimental_launcher)
## Table of Contents
- [Table of Contents](#table-of-contents)
- [About](#about)
- [Features](#features)
- [Installation](#installation)
- [Contributing](#-contributing)
- [Build from source](#build-from-source)
- [Install Node.js](#install-nodejs)
- [Install Yarn](#install-yarn)
- [Install Node Dependencies](#install-node-dependencies)
- [Running](#running)
- [Build](#build)
- [Contributors](#contributors)
- [License](#license)
## About
The Redot Engine Launcher is a centralized hub designed to streamline your development workflow.
## Features
- **Manage, Update, and Install Redot Engine Versions**: Easily switch between different versions of the Redot Engine to suit your project needs.
- **Organize Existing Projects**: Keep all your Redot projects in one place with easy access and management tools.
- **Manage Addons and Asset Packs**: Browse, install, and update addons and asset packs to enhance your development experience.
## Installation
Follow the steps below to install:
1. Download the latest version of Redot Engine Launcher from the [Releases](https://github.com/Redot-Experimental/launcher/releases/latest) page.
- Download only `.exe` if you want to install Redot Engine Launcher on Windows.
- Download `.deb`, `.rpm`, or `.zip` if you want to install Redot Engine Launcher on Linux (depends on your Linux distro).
- Download `.dmg` if you want to install Redot Engine Launcher on macOS.
2. Run the downloaded or installed file from your Applications folder.
3. Enjoy Redot Engine Launcher!
## Contributing
Redot is not only an engine but an ever-growing community of users and engine
developers. Please visit our [Discord server](https://discord.gg/redot)!
To get started contributing to the project, see the [contributing guide](CONTRIBUTING.md).
This document also includes guidelines for reporting bugs.
## Build from source
### Install Node.js
Make sure Node.js is installed on your machine. If it's not, you can download and install it from [nodejs.org](https://nodejs.org/).
### Install Yarn
Yarn is a package manager for Node.js. If you haven't installed it yet, you can do so by following the instructions on [yarnpkg.com](https://classic.yarnpkg.com/lang/en/docs/install/).
### Install Node Dependencies
Go to the project directory and install the Node dependencies using Yarn:
```bash
cd launcher
yarn
```
## Running
Once everything is set up, you can run the following command to start the Electron process:
```bash
yarn dev
```
## Build
Build the Electron application using the following command:
On Windows:
```bash
yarn build:win
```
On Linux:
```bash
yarn build:linux
```
On macOS:
```bash
yarn build:mac
```
## Contributors
## License
The Redot Engine Launcher is licensed under the [MIT License](LICENSE).