Creepyr README

Creepyr: A CLI Minecraft launcher/server-launcher/pack-dev-tool written in Python by Dunkmania101

Installation

Git Clone

# Download Creepyr
git clone https://github.com/Dunkmania101/Creepyr --depth=1
# Install dependencies
pip3 install -Ur Creepyr/requirements.txt
# Install Creepyr
cp Creepyr/creepyr.py YOUR_PROGRAM_DIR/creepyr.py
# Make sure it works
python3 YOUR_PROGRAM_DIR/creepyr.py --help

Usage

General

Show Help

python3 YOUR_PROGRAM_DIR/creepyr.py help

Accounts

Add An Account

Token

python3 YOUR_PROGRAM_DIR/creepyr.py account create LOCAL_ACCOUNT_NAME USERNAME UUID TOKEN ACCOUNT_JSON_FILE

Mojang

echo TODO

Microsoft

echo TODO

Instance Creation

python3 YOUR_PROGRAM_DIR/creepyr.py instance create INSTANCE_JSON_FILE LOCAL_INSTANCE_NAME MINECRAFT_DIR MINECRAFT_VERSION \
    MINECRAFT_TYPE \ # One of: vanilla, forge, fabric
MOD_LOADER_VERSION \ # "" if using vanilla
JVM_EXEC \ # Likely /usr/lib/jvm/default/bin/java on Unix-like systems
JVM_ARGS # Needs to be in quotes as one long, space-delimited string

Instance Installation

python3 YOUR_PROGRAM_DIR/creepyr.py instance install INSTANCE_JSON_FILE
# OR, if using CurseForge mods:
python3 YOUR_PROGRAM_DIR/creepyr.py instance install INSTANCE_JSON_FILE cfapikey=CURSEFORGE_API_KEY

Only Minecraft

python3 YOUR_PROGRAM_DIR/creepyr.py instance install-mc INSTANCE_JSON_FILE

Only Mods

python3 YOUR_PROGRAM_DIR/creepyr.py instance install-mods INSTANCE_JSON_FILE
# OR, if using CurseForge mods:
python3 YOUR_PROGRAM_DIR/creepyr.py instance install-mods INSTANCE_JSON_FILE cfapikey=CURSEFORGE_API_KEY

Only CurseForge Mods

python3 YOUR_PROGRAM_DIR/creepyr.py instance install-mods-cf INSTANCE_JSON_FILE cfapikey=CURSEFORGE_API_KEY

Only Modrinth Mods

python3 YOUR_PROGRAM_DIR/creepyr.py instance install-mods-mr INSTANCE_JSON_FILE

Instance Updating

python3 YOUR_PROGRAM_DIR/creepyr.py instance update INSTANCE_JSON_FILE
# OR, if using CurseForge mods:
python3 YOUR_PROGRAM_DIR/creepyr.py instance update INSTANCE_JSON_FILE cfapikey=CURSEFORGE_API_KEY

Only Minecraft

python3 YOUR_PROGRAM_DIR/creepyr.py instance update-mc INSTANCE_JSON_FILE

Only Mod Loader

python3 YOUR_PROGRAM_DIR/creepyr.py instance update-ml INSTANCE_JSON_FILE

Instance Launching

python3 YOUR_PROGRAM_DIR/creepyr.py instance run INSTANCE_JSON_FILE ACCOUNT_JSON_FILE

Passing Account With STDIN

python3 YOUR_PROGRAM_DIR/creepyr.py instance run INSTANCE_JSON_FILE stdin LOCAL_ACCOUNT_NAME USERNAME UUID TOKEN

Passing Instance With STDIN

python3 YOUR_PROGRAM_DIR/creepyr.py instance run stdin LOCAL_NAME MINECRAFT_DIR MINECRAFT_VERSION \
MINECRAFT_TYPE \ # One of: vanilla, forge, fabric
MOD_LOADER_VERSION \ # "" if using vanilla
JVM_EXEC \ # Likely /usr/lib/jvm/default/bin/java on Unix-like systems
JVM_ARGS \ # Needs to be in quotes as one long, space-delimited string
ACCOUNT_JSON_FILE

Passing Everything With STDIN

python3 YOUR_PROGRAM_DIR/creepyr.py instance run stdin LOCAL_NAME MINECRAFT_DIR MINECRAFT_VERSION \
MINECRAFT_TYPE \ # One of: vanilla, forge, fabric
MOD_LOADER_VERSION \ # "" if using vanilla
JVM_EXEC \ # Likely /usr/lib/jvm/default/bin/java on Unix-like systems
JVM_ARGS \ # Needs to be in quotes as one long, space-delimited string
stdin LOCAL_ACCOUNT_NAME USERNAME UUID TOKEN

Mod Installation

CurseForge Mods

python3 YOUR_PROGRAM_DIR/creepyr.py instance install-mod-cf INSTANCE_JSON_FILE PROJECT_ID FILE_ID cfapikey=CURSEFORGE_API_KEY

Modrinth Mods

python3 YOUR_PROGRAM_DIR/creepyr.py instance install-mod-mr INSTANCE_JSON_FILE PROJECT_ID FILE_ID

License

MIT License

Copyright (c) 2024 Duncan Brasher (Dunkmania101)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.