auto-mcs

![inqSerdiagram](https://github.com/macarooni-man/auto-mcs/blob/main/other/github-banner-cropped.png?raw=true)
[![Latest Release](https://img.shields.io/github/v/release/macarooni-man/auto-mcs)](https://www.auto-mcs.com)
# auto-mcs
Welcome to auto-mcs! This software provides a simple and easy-to-digest experience for those who want to play Minecraft with their friends without the hassle of server installation & maintenance.
<br><br>

Some notable features include:
 - Create a server in less than a minute
 - No port forwarding required with our [playit.gg integration](https://playit.gg)
 - Mod & plug-in manager with Modrinth integration for search, installation, and updates
 - Import any modpack or existing server
 - Switch worlds, versions, or modloaders/distributions on the fly
 - Automatic server installation & updates
 - Automatic back-up management
 - Custom console with a [universal scripting API](https://auto-mcs.com/guides/amscript) (compatible with Vanilla) and a built-in IDE
 - Firewall-like Access Control menu to manage operators, bans, and the whitelist from a single page
 - Custom [remote access solution](https://www.auto-mcs.com/guides/telepath) for management on the go
 - Detailed crash detection with an accessible report
 - Built-in `server.properties` editor for ease of use
 - And so much more...

 auto-mcs completely supports, updates, and manages:
 Paper - Purpur - Fabric - Quilt - NeoForge - Forge - Spigot - CraftBukkit - Vanilla

<br><br>
# Installation & Setup
To get started, download the latest version of auto-mcs [from the website](https://www.auto-mcs.com/download), or [from GitHub](https://github.com/macarooni-man/auto-mcs/releases/latest). Extract auto-mcs from the `.zip` file to a location of your choice and launch it. That's it, there's no installation required!
> Note:  If you're using Linux, you might need to run `chmod +x auto-mcs` to give the binary executable permission

If you'd like to compile auto-mcs yourself, take a peek at the [build documentation](https://github.com/macarooni-man/auto-mcs/blob/main/build-tools/README.md)!

If you're using our Docker implementation, please take a look at our documentation on [Docker Hub](https://hub.docker.com/r/macarooniman/auto-mcs)!

<br>
To start, you can either import a server you've made on your own or create a new one from scratch:

### Create a New Server
- For the vast majority of users, auto-mcs is preconfigured to provide optimal settings. Check out our instant server templates to start playing immediately!

- For a customized experience, you can choose a different distribution with mods, an older version, or even choose to set up a whitelist. There are a plethora of options to configure manually.

- You can also use a modpack from the built-in Modrinth browser, or by importing a `.zip`/`.mrpack` file. 

### Import a Server
- auto-mcs can detect and manage a wide variety of servers that you have made yourself. Select the root folder of the server and click import to use all of auto-mcs's features!
> Note: Importing will copy your server to a different directory and create a backup. The original directory will be untouched

<br>
And that's it - click launch to play with your friends!

<br><br>

# Advanced Configuration
As this is a relatively new project, a lot of things have and may change during development. [Visit the website for a comprehensive overview of all the features provided by auto-mcs](https://www.auto-mcs.com/guides).


<br><br>

# Contact & Inquiries
- If you experience a crash, please submit an issue with the bug label including the crash report provided by auto-mcs.
<br><br>
- If you experience a bug, please submit an issue with the bug label including screenshots or a detailed description and location of the problem.
<br><br>
- For all other inquiries including security issues or suggestions, [please contact us directly via email](mailto:help@auto-mcs.com?subject=Inquiry%20-%20).

<br><br>

# Additional Information
- auto-mcs is and will continue to be a free project for anyone to use. If you feel as though this project has brought you value, [please consider donating](https://github.com/sponsors/macarooni-man) to the continued development and maturity of auto-mcs. Thank you!
<br><br>
- auto-mcs will not transfer any information to other networked systems unless explicitly requested by any party involved with installing or operating it
<br><br>
- By using this software you agree to the [terms & conditions](https://www.auto-mcs.com/terms-and-conditions)

<br><br>

# Sponsors
<table>
 <tbody>
  <tr>
   <td align="center"><img alt="[SignPath]" src="https://avatars.githubusercontent.com/u/34448643" height="30"/></td>
   <td>Free code signing on Windows provided by <a href="https://signpath.io/">SignPath.io</a>, certificate by <a href="https://signpath.org/">SignPath Foundation</a></td>
  </tr>
 </tbody>
</table>