Skip to content

Jamalam360/sourcecraft

Repository files navigation

Sourcecraft

Sourcecraft is a simple-to-use Minecraft decompiler, run on GitHub actions.

How to Use

  1. Create a repository from this template, making sure to set it as private.
  2. (Optional) Update .github/workflows/decompile.yml, setting ONLY_INCLUDE_STABLE_VERSIONS to false, if you wish for snapshot decompilations to be created.
  3. Sourcecraft will automatically run its GitHub action periodically, generating decompiled Minecraft sources and pushing them to a new branch for each version.

Environment Variables

These can be edited in the GitHub action workflow file, at the path .github/workflows/decompile.yml.

Name Description Default
ONLY_INCLUDE_STABLE_VERSIONS Whether to only decompile stable versions. If set to false, snapshots, pre-releases, and release-candidates will be decompiled as well. true
IGNORED_VERSIONS A comma separated list of versions that will not be decompiled. This overrides the DECOMPILE_VERSIONS flag. []
DECOMPILE_VERSIONS A comma separated list of versions that will be decompiled. This is ignored if IGNORED_VERSIONS is not empty. ONLY_INCLUDE_STABLE_VERSIONS will be bypassed if this is given All versions supported by Quilt mappings (gathered from meta.quiltmc.org).

Why?

I often have ideas on-the-go. Whether it be how to fix a bug or how to implement a feature. If I can't look at the source code immediately, that idea is pretty much gone! I need a way to browse it on my phone.

There are other tools that generate decompiled Minecraft sources, but they were too configurable and I couldn't get them to run.

What?

Sourcecraft uses Quiltflower, Quilt Mappings, Quilt Loom, and a Deno script to generate sources. I will not add options for other tooling, as it goes against the point of what I am trying to do.

Sourcecraft also pulls in the latest Quilted Fabric API, so injected interfaces may be browsed.

Disclaimer

I am not responsible for any trouble you get into using Sourcecraft. Keep the repositories private and don't go sharing the source.

About

An opinionated way to generate Minecraft sources.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published