Skip to content

Commit

Permalink
chore: Create README
Browse files Browse the repository at this point in the history
  • Loading branch information
BenMcAvoy committed Dec 9, 2024
1 parent 7aaa230 commit fde73b7
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Carbon Launcher

**Carbon Launcher** is a powerful and user-friendly modding launcher for [Scrap Mechanic](https://www.scrapmechanic.com/), designed to support DLL mods and provide cloud synchronization for an enhanced modding experience. With Carbon Launcher, players can seamlessly download and manage DLL mods from a variety of online repositories, creating a vast library of modding content directly accessible from the launcher.

Whether you're a veteran modder or a newcomer, Carbon Launcher simplifies the process of discovering, installing, and managing mods with automatic updates and a streamlined user interface.

## Features

- **Cloud Sync:** Your mod setup is synced across people on join if they also use Carbon Launcher, so you can play with your friends
- **Wide Repository Access:** The launcher connects to multiple mod repositories, giving you access to a diverse range of mods that can enhance your [Scrap Mechanic](https://www.scrapmechanic.com/) experience.
- **Seamless Installation & Uninstallation:** Installing mods is as simple as a few clicks, and removing them is just as easy.
- **Auto-Updates:** Mods are kept up to date with minimal effort. Any new versions or updates from the repository are automatically fetched and installed.
- **Community Support:** Participate in the growing modding community by submitting your own mods, or use the launcher to browse and contribute to shared content.

## Installation

### Prerequisites

- Visual C++ Redistrutables
- OpenGL support

### Steps to Install:

1. **Download** the latest release of Carbon Launcher from the official repository (or your preferred source).
2. **Extract** the downloaded zip file to a desired location on your system.
3. Run **CarbonLauncher.exe** to start the application.

## Usage

Once the launcher is installed, follow these steps to start using it:

1. Open the **Carbon Launcher**.
2. Browse or search for the DLL mods you wish to install from the repositories.
3. Select and **download** the mods you want. The launcher will automatically install them for you.
4. Once installed, the mods will appear in the installed section, where you can enable or disable them with ease.
5. Enjoy your new mods in [Scrap Mechanic](https://www.scrapmechanic.com/) when you press the play button

## Contributing

**Carbon Launcher** is an open-source project, and contributions are welcome!

If you’d like to contribute, here’s how:

### Reporting Issues
If you encounter any bugs or have suggestions, feel free to open an issue in the issue tracker on GitHub.

### Submitting a Pull Request
To contribute new features or bug fixes, fork the repository and submit a pull request. Be sure to follow the contribution guidelines:
- Make sure your changes are thoroughly tested.
- Follow the existing code style and formatting.
- Provide a clear and concise description of your changes.
- Use common sense

### Ideas & Improvements
We encourage feedback and suggestions. If you have any ideas for new features or improvements, please open an issue and share your thoughts!

## Known Issues

- **Compatibility:** Some mods may not be compatible with certain game versions. Always check mod compatibility before downloading.

## License

Carbon Launcher is open source and distributed under the [MIT License](LICENSE).

## Acknowledgements

- Thanks to all contributors for their hard work and dedication.
- Special thanks to the Scrap Mechanic modding community for their continued support and creativity.

0 comments on commit fde73b7

Please sign in to comment.