README.md

Creators.TF Community Launcher (Alpha)

This repository contains the source code and releases for the Creators.TF Community Launcher

Core features:

• Launcher auto-updating (Only via .exe and .AppImage)
• Custom mod support
• GitHub release mod support
• More details on our website page

Useful links for this repository:

• Releases -- Latest release
• Changelogs
• License
• Code of Conduct (TL;DR; common sense)

Maintainers

• Jota - [email protected] - UI and UX Lead
• rob5300 - [email protected] - Core Feature Lead

Contributing

If you have something to contribute, please, open a pull request! Make sure your PR tries to solve/improve one thing at a time and isn't messy. Pull requests should always have a specific goal to accomplish.

Please do NOT make a pull request or change that only seeks to change code styling or do "housekeeping" as these will be denied and closed.

If you have a bug report or a suggestion, open an issue! Try to use the templates and give good information. The launcher is currently in an alpha state so any help is appreciated.

Launching and Building from Source

If you want to build the launcher yourself, you need to have Node.js installed, which should also include npm. Clone the repository using git (or download from this page) and do npm install in the main repository using your system's CLI to download the required packages.

You can start the launcher for testing purposes without building via npm run compileAndStart.

You can build for Windows or Linux via the included build scripts using npm run buildWindows or npm run buildLinux. If you need, you can edit these in package.json to build to your liking, but changes made to these should not be committed if you plan to make a PR.