gdpack

A small, single-purpose CLI application for managing Godot addons.

⚠️ WARNING: This project is in a very early stage. API instability, missing features, and bugs are to be expected for now.

How it works

TODO

Getting started

These instructions will help you install gdpack and manage addons for your Godot projects.

Example usage

TODO

Installation

See docs/installation.md for detailed instructions on how to download gdpack.

API Reference

Commands

See docs/commands.md for a detailed reference on how to use each command.

Development

Setup

The following instructions outline how to get the project set up for local development:

1. Follow the instructions to install Rust (see Cargo.toml for the minimum required version).
2. Clone the coffeebeats/gdpack repository.
3. Install the tools used below by following each of their specific installation instructions.

Code submission

When submitting code for review, ensure the following requirements are met:

1. The project is correctly formatted using rustfmt:

   cargo fmt

2. All clippy linter warnings are addressed:

   cargo clippy \
       --all-features \
       --all-targets \
       --no-deps \
       -- \
           --deny=warnings

3. All unit tests pass:

   cargo test \
       --all-features \
       --all-targets \
       --frozen \
       --release

4. The gdpack binary successfully compiles using Cross (release artifacts will be available in ./target). Follow the installation instructions to ensure cross is installed on the development system.

   cross build \
       --manifest-path=Cargo.toml \
       --profile=release \
       --frozen \
       --all-targets

Contributing

All contributions are welcome! Feel free to file bugs and feature requests and/or open pull requests.

Version history

See CHANGELOG.md.

License

MIT License