Skip to main content

Version manager for decompiled Minecraft source code

Project description

Shulkr

Shulkr is a tool that decompiles multiple versions of Minecraft and commits each version to Git

Requirements

  • Git
  • JDK (>= 17 for Minecraft 1.18)
  • Gradle >= 7.3

Installation

pip install shulkr

Usage

shulkr 1.16 1.17 1.18

A commit with the decompiled source code will be generated for each specified version of Minecraft:

40240b1 version 1.18
86dc440 version 1.17
5d13494 version 1.16

Version Patterns

Ranges of versions can be specified with the .. and ... operators:

  • A..B expands to all versions between A and B (inclusive), not including snapshots
  • A...B expands to all versions between A and B (inclusive), including snapshots

A and/or B can be omitted, defaulting to the earliest and latest supported versions, respectively.

Options

--repo / -p

By default the source code is generated in the current working directory. To specify a different location:

shulkr --repo minecraft-sources MINECRAFT_VERSION

If the directory does not exist, a new git repo will be created there.

--message / -m

This option lets you customize the commit message format:

shulkr -m "Minecraft {}" 1.18-rc4

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

Licensed under the Apache License, Version 2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shulkr-0.1.1.tar.gz (12.9 kB view hashes)

Uploaded Source

Built Distribution

shulkr-0.1.1-py3-none-any.whl (3.8 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page