Skip to content

Osiris-Team/AutoPlug-Client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,017 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AutoPlug-Client is a standalone, executable Java program that has multiple execution modes: Server-Wrapper, CLI-Tool, Background-Service. Its main purpose is to automate updating of any sofware related to servers and simplify server maintenance in general. While all server types are compatible (including Steam game servers), the majority of its features cater specifically to Minecraft, which is renowned as the world's top-selling game and boasts an exceptionally extensive modding community.

Links

What can it do?

  • Automated self, server-software, plugins, mods and JRE (Java Runtime Enviornment) updating
  • Scheduled server restarts
  • Automated, modularized backup creation
  • Fast, asynchronous, multithreaded task execution
  • Have synchronized (shared) folders
  • Web-Panel for starting, stopping restarting the server and viewing the last updating results summaries

Premium AutoPlug-Web features:

Status

Stable and feature-complete, thus community driven development, meaning the lead developer will not develop new features and rely on pull requests by others, except for security issues and critical bugs.

Community projects

Developers:

You can also use AutoPlug in your projects by adding it as a dependency via Maven/Gradle/Sbt/Leinigen. Some useful classes would be the AutoPlugConsole for example, which lets you execute AutoPlug commands programmatically:

AutoPlugConsole.executeCommand(".check plugins");
AutoPlugConsole.executeCommand(".check server");
// etc...

Contribute

Thank you for considering to contribute, the community 💙 that! Just keep these things in mind:

  • Create an issue first if you want to do big changes, so we can discuss it.
  • Remember that big changes also require you to write tests.
  • You can pick and work on any open issue. Let us know that you are working on it.
  • Avoid using and writing static methods/fields/classes to ensure minimal memory usage.

Beginners:

Building:

  • Written in Java, with JDK 8, inside of IntelliJ IDEA
  • Built with 1JPM, command: java ./src/main/java/JPM.java (if you want to directly run it too append andRun at the end).

Bounties:

  • Some issues are labeled like bounty: 50€ (show the list). The first accepted pull request that fully fixes/closes the issue receives the bounty.
View Terms
  • Your PR must include at least one test proving the fix or feature works.
  • Payments are only made via PayPal.
  • Your PayPal email must be visible somewhere on your public GitHub profile before the PR is merged.
  • By submitting a PR for a bounty issue, you agree to these terms.
  • Low-quality, incomplete, or spam PRs may be closed without review.

AI Generated Pull Requests

  • AI-assisted code is allowed, but the submitter must fully review, understand, and test all generated code before opening the PR.
  • The PR author is fully responsible for all generated code and behavior.
  • PRs generated mostly by AI must clearly state this in the description.
  • AI-generated PRs require manual human review before merge.
  • Large AI-generated rewrites, formatting-only changes, hallucinated APIs, duplicate logic, or low-effort generated spam will be rejected.
  • Repeated submission of low-quality AI-generated PRs may result in bounty disqualification or repository bans.

Code Quality Requirements

  • Keep PRs focused and limited to a single issue or feature.
  • Follow the existing project structure, architecture, naming conventions, and coding style.
  • Reuse existing APIs, utility classes, helpers, and abstractions whenever possible.
  • Integrate changes into the existing code flow instead of bypassing, replacing, or duplicating major logic.
  • Avoid unnecessary rewrites, new abstractions, excessive refactors, or unrelated cleanup.
  • Do not introduce new dependencies or frameworks unless clearly justified.
  • PRs must include a clear description of:
    • what changed
    • why it changed
    • how it was tested
  • PRs with failing builds, missing tests, broken functionality, or unreviewed generated code will be rejected.
  • If a PR requires excessive maintainer cleanup, restructuring, or debugging, it may be closed.
  • Repeated low-quality submissions may result in bounty disqualification or repository bans.

Libraries

Note that this list may be outdated. Check the build.gradle file for our current dependencies.

  • AutoPlug-Core contains frequently used code accross all AutoPlug projects in one jar.
  • Dream-Yaml is used for handling YAML files.
  • Better-Thread enables display of 'live-tasks'.
  • For console coloring and task display Jansi and Jline is used.
  • Zip4j to unpack and handle jar/zips.
  • Server restarts are scheduled with Quartz.

About

Server manager with automatic plugin- mod- server- java- self- updater, scheduled restarts, automatic backups, shared folders, and many more handy features to automate/boost your server maintenance.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages