An open API service indexing awesome lists of open source software.

https://github.com/electron-minecraft-launcher/eml-admintool-v2

Manage your Minecraft Launcher (working with EML Lib) from the Web.
https://github.com/electron-minecraft-launcher/eml-admintool-v2

admin admintool electron expressjs files launcher maintenance manage minecraft news nodejs panel svelte sveltekit updater web

Last synced: 6 months ago
JSON representation

Manage your Minecraft Launcher (working with EML Lib) from the Web.

Awesome Lists containing this project

README

          

# EML AdminTool

**EML AdminTool is a Web software to manage a Minecraft Launcher built with [EML Lib](https://github.com/Electron-Minecraft-Launcher/EML-Lib-v2) library.**

![EML AdminTool](./.github/assets/files-updater.png)

[

](https://discord.gg/YVB4k6HzAY)
[](#platforms)
[](package.json)

---

## Features

* **Files Updater**: Update your Minecraft files and loader (Vanilla or Forge).
* **Bootstraps**: Auto-update your Minecraft Launcher.
* **Maintenance**: Manage your Minecraft Launcher.
* **News**: Manage your Minecraft Launcher news.
* **Background**: Manage your Minecraft Launcher background.
* **Stats**: See stats about your Launcher.
* The Admin of the server can manage the users permissions.
* And more...

## Installation

Please follow [this guide](https://emlproject.qzz.io/documentation/).

### If you won't use a VPS

You can download the previous major version of the [EML AdminTool](https://github.com/Electron-Minecraft-Launcher/EML-AdminTool). However, be careful, this version is no longer maintained and has security vulnerabilities.

## Contributing

### Translation

You can help to translate EML AdminTool!

The languages files are [here](./client/src/lib/locales/). You can create another file with your translation. Please make sure to provide a correct translation!

Then, you can submit your translation file as an [issue](https://github.com/Electron-Minecraft-Launcher/EML-AdminTool-v2/issues/new?template=translation.md), by using the *Language* issue template. Your file needs to be checked and approved by two other persons.

### Development

Install [Node.js](https://nodejs.org/en/download/package-manager) and [Docker](https://www.docker.com/get-started) [^3].

Then, download the code and run the command:
```bash
cd EML-AdminTool-v2
npm i
```

You can now start the development server:
```bash
cd docker
docker-compose -f dockerfile.dev.yml up
```

The application is accessible at [http://localhost:5173](http://localhost:5173). You can also access pgAdmin at [https://localhost:5050](http://localhost:5050).

You can now make pull requests!

## Important information

* This repository contains a `.env` file. All the information in this file is fake (random strings), and will be replaced by the real information when you install EML AdminTool.
* This Web software is under the `GNU AGPLv3` license; to get more information, please read the file `LICENSE`. It is legally obligatory to respect this license.
* If you need some help, you can join [this Discord](https://discord.gg/nfEHKtghPh).


[^1]: The Docker Engine installation tutorial from the official Docker documentation includes the installation of Docker Compose.

[^2]: NGINX (or Apache) is recommended to use EML AdminTool in production. It allows you to use a domain name and an SSL certificate. If you don't use NGINX (or Apache), you can use EML AdminTool with the IP address of your VPS. However, it is not recommended to use EML AdminTool without a domain name and an SSL certificate.

[^3]: On desktop (Windows, macOS and Linux), you can use Docker Desktop, which includes Docker and Docker Compose. On a server (Linux), you should install Docker and Docker Compose separately.