fossabot/westgatexl

WestgateXL is a simple, yet powerful Minecraft custom launcher with a strong focus on the user experience

GDLauncher

Table of Contents (click to expand)

• Getting Started
• Features
• Compilation
• Compilation Requirements
• Compilation Steps
• Packaging
• Built and Managed with
• Contributing
• Versioning
• Authors
• License
• Todos

This project was previously developed in C#. That version is now outdated and not mantained but you can find the code here

GDLauncher is a custom open source Minecraft launcher written from the ground up in electron/react. Its main goal is to make it easy and enjoyable to manage different Minecraft versions and servers, bringing the playing and modding experience to the next level!

🚀 Getting Started

Below you will find everything you need to know about the launcher. If you want to download a stable release you can do it from our official website (https://gdevs.io). If you want the latest testing features you can clone the repo and compile it yourself.

🎮 Download

To download the latest version, you can either click here and select the appropriate version for your operating system, or visit our website.

🎨 Features (Working on)

• Java Autorunner. You don't need to have java installed, a suitable version will be downloaded automatically.
• Log console. Always know what's happening.
• Easy installation. It's as easy as pie to install both the vanilla game and forge. No further action from the user is required.
• Built-in autoupdater. You will never need to download a new version manually.
• Vanilla, Forge, and Curse modpacks download and autoupdater.
• Built-in manager for Minecraft servers.
• Cloud sync of game saves. You will never lose your saves again!

You can also:

• Import and export modpacks from and to other launchers
• Drag and drop instances wherever you like them, just like in your desktop
• Keep track of the time you played each instance
• Add instances to the download queue, they will automatically download one after the other
• Manage your minecraft skin directly from the launcher
• Directly connect to a server from the launcher using quick launch

Keep in mind that not all of these features are yet part of the launcher. We are constantly updating the code adding new features. Feel free to help us :)

💾 Compilation

These are the steps to compile it yourself.

⚙️ Requirements

You need the following softwares installed:

• Nodejs (> 8)
• yarn

▶️ Steps

Install the dependencies and devDependencies.

$ cd GDLauncher
$ yarn

Start the development environment

$ yarn dev

For production environment...

$ yarn start

🚚 Packaging

To package apps for the local platform:

$ yarn package

To package apps for all platforms:

First, refer to Multi Platform Build for dependencies.

Then,

$ yarn package-all

🚀 Built and managed with

• Javascript - Language used
• React - JS Framework
• Redux - React state management
• NodeJS - JS Runtime
• Electron - JS Framework
• Travis CI - CI Service
• Codacy - Automated code review
• Webpack - JS module bundler
• Babel - JS Transpiler
• ESLint - JS Linter
• Ant Design - UI Design Language

🎁 Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

📜 Versioning

We use SemVer as versioning system.

❤️ Authors

• Davide Ceschia - Initial work - GorillaDevs

See also the list of contributors who participated in this project.

🎓 License

This project is licensed under the GNU GPL V3.0 - see the LICENSE file for details

✏️ Todos

Here is the complete list of things we want to do. If you want to help us doing them or want to suggest some new ideas, comment here! TODOS/IDEAS