A command-line tool for creating and building Ownables - digital assets with unique visual and audio experiences.

Before using the Ownables CLI, you'll need to set up your development environment:

1. Install Rust:

   • Visit https://rustup.rs/
   • Download and run the installer

2. Install Visual Studio Build Tools:

   • Download from Visual Studio Downloads
   • Select "Desktop development with C++"

3. Install wasm-bindgen:

   cargo install wasm-bindgen-cli

4. Add WebAssembly target:

   rustup target add wasm32-unknown-unknown

1. Install Rust:

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

2. Install Xcode Command Line Tools:

   xcode-select --install

3. Install wasm-bindgen:

   cargo install wasm-bindgen-cli

4. Add WebAssembly target:

   rustup target add wasm32-unknown-unknown

1. Install Rust:

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

2. Install build essentials:

   sudo apt-get update
   sudo apt-get install build-essential

3. Install wasm-bindgen:

   cargo install wasm-bindgen-cli

4. Add WebAssembly target:

   rustup target add wasm32-unknown-unknown

Install the Ownables CLI globally:

npm install -g @ltonetwork/ownables-cli

1. Create a new project:

   ownables create

2. Choose your template:

   • Static Ownable: For displaying a single image
   • Music Ownable: For audio with cover art and backdrop

3. Follow the prompts to:

   • Name your ownable
   • Add a description
   • Set version
   • Add authors
   • Add keywords

1. Add your image to assets/images/
   • Supported formats: jpg, jpeg, png, webp
   • Minimum size: 300x300 pixels
   • Maximum size: 4096x4096 pixels
   • Maximum file size: 50MB

1. Add your audio file to assets/audio/

   • Format: mp3
   • Maximum size: 50MB

2. Add your images to assets/images/:

   • Cover art: Name with 'cover' or 'front' (e.g., 'cover.jpg')
   • Backdrop: Name with 'backdrop' or 'back' (e.g., 'backdrop.jpg')
   • Same requirements as static ownable images

1. Run the build command:

   ownables build

2. The CLI will:

   • Compile your code
   • Process your assets, schema, wasm and build
   • Create a package (a zip file) in the build directory - this is your ownable!

your-ownable/
├── assets/
│   ├── images/     # Your image files
│   ├── audio/      # Your audio files (music ownables only)
│   └── index.html  # Display template
├── src/            # Rust source code
└── Cargo.toml      # Project configuration

If you encounter any issues:

1. Check that all prerequisites are installed
2. Verify your assets meet the requirements
3. Ensure you're in the correct directory when running commands