Drehmal-Team / installer

An installer made for Drehmal 2.2: Apotheosis to simplify the map's installation process.
https://drehmal.net
10 stars 2 forks source link

Drehmal 2.2: Apotheosis Installer

Discord

An installer made for Drehmal 2.2: Apotheosis to simplify the map's installation process.

Features

How-To

Bugs

If you encounter issues with the installer, please check open bug reports to see if your issue has already been reported, if there are any updates, workarounds etc.

If there isn't an open report for your issue, then please fill out a bug report with the requested information.

The most helpful part is uploading your log file, so please don't forget to do that. Logs can be found at one of these locations:

Thanks in advance <3

Credits

This project was created using Quasar, Electron, and Vue with HTML, CSS and TypeScript in VSCode.

Mods

Massive thanks to each of the following Minecraft mods for enhancing the experience and immersiveness of the map!

Shaders

Additional thanks goes out to Sildur for creating Sildur's Enhanced Default!

Development

Created using Quasar, Electron, and Vue with HTML, CSS and TypeScript in VSCode.

Quasar is a meta-framework for VueJS and is what handles the cofiguration for Electron, Vue, and Vite. Quasar's configutation file is almost always the intentional method of updating the project's configuration. Documentation for that can be found on their docs page, and the configuration file provides IDE autocomplete. Quasar also provides many helpers such as a $q object (useQuasar() in script setup), and pre-made components to work with.

Development mode supports hot-code reloading, error reporting etc. via Quasar. package.json includes common quasar commands, removing/reducing the need to use Quasar's CLI directly, though it is still useful and recommended to know. Documentation here.

# Install dependencies
yarn
# build the project in development mode (hot reloading, auto-recompilation etc.)
yarn dev
# lint project for errors or warnings
yarn lint
# clean re-install: removes /node_modules, /dist etc. and re-fetches deps
yarn clean

Building

Build commands are platform-specific, and you must be on that platform to build for it. This is automated via GitHub actions using this workflow when a new tag is created. To begin the workflow, draft a new release with a new tag. Choose an appropriate title and description. GitHub will build for all platforms and add each platform's files to the newly created release.

If you would like to build a release locally for your current platform, you may use one of the following commands (after cloning the repo).

# you must be on that platform to build a release for it
yarn build:win
yarn build:linux
yarn build:osx