KJSPKG

A simple package manager for KubeJS written in Go.

The Go API exposed at github.com/Modern-Modpacks/kjspkg/pkg/kjspkg is not stable. It is not recommended to use it just yet.

Installation & Update

Install script

This script will install KJSPKG to your system and add it to your PATH.

# On Linux
curl -fsSL https://g.tizu.dev/mm.kj/install.sh?r | bash
# On Windows
powershell -c "irm https://g.tizu.dev/mm.kj/install.ps1?r | iex"

Using Go

This requires a working Go installation of at least 1.23.2.

go install github.com/Modern-Modpacks/kjspkg/cmd/kjspkg@latest

Usage

KJSPKG comes with extensive help text, so you can just run kjspkg to see all the commands and options available. You may also use --help after any command to get more information about it.

kjspkg install [package] [package]
kjspkg remove [package] [package]
kjspkg update [package] [package]

Adding your own package

Through KJSPKG Lookup (Web UI)

You now have the ability to upload packages using KJSPKG Lookup, a web tool originally meant to quickly search for packages on KJSPKG, but it now supports the addition of them as well.

1. Go to https://kjspkglookup.modernmodpacks.site/
2. Click the user icon in the top right corner and log in using your GitHub account
3. Click on your profile picture. That should lead you to your KJSPKG profile; from there you can press the plus icon to create a new package
4. Fill in all the required details and upload the scripts
5. Press publish and wait for your script to be approved by us, then it should appear on the website
6. profit

NOTE: There is currently a known bug concerning GitHub authentication permissions which can cause an error during the last step. This is why we recommend you first log out and log back into your GitHub account before starting the process of uploading the package if it's your first time using the KJSPKG Lookup website.

Manual setup

If other methods don't fit your particular situation or you just want a higher degree of control, you can set up the repository for your package manually using Git.

1. Create a repository containing your scripts and assets
2. Don't forget to license your code
3. Create an empty directory and run kjspkg dev init
4. Do your thing and create a repository with the code
5. Fork this repo
6. Clone it
7. Add your package to pkgs.json file. Format it like this: "your_package_id": "your_github_name/your_repo_name[$path/to/your/package/directory][@branch_name]",
   • Things in [] are optional
   • Only specify the path if you have multiple packages in one repository. If you do, specify the path where the .kjspkg file is located at
   • Branch is main by default
8. Create a pull request
9. Wait for it to be accepted
10. profit

KJSPKG badges

[![kjspkg-available](https://github-production-user-asset-6210df.s3.amazonaws.com/79367505/250114674-fb848719-d52e-471b-a6cf-2c0ea6729f1c.svg)](https://kjspkglookup.modernmodpacks.site/#{packagename})

Supported versions

Tested means that the version is confirmed to be working;

Not tested means that the version should work, but hasn't been tested. Feel free to test it yourself and let us know so we'll update the readme.

Full support means that we focus on that version;

Partial support means that the version is supported, but not as much as the fully supported ones;

No support means that the version works, but any issues that you have with it won't be fixed.

Borked means it doesn't work lmao.