npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

arcadia-machine

v0.0.13

Published

The Machine is an atomic asset creator tool for deploying collections to the permaweb. To deploy a collection, you need a directory containing the following files:

Downloads

4

Readme

The Machine

The Machine is an atomic asset creator tool for deploying collections to the permaweb. To deploy a collection, you need a directory containing the following files:

  • collection.json
  • 1..X.png or 1..X.mp3 etc.
  • banner.png
  • thumbnail.png

Usage

npm i @permaweb/machine
npx @permaweb/machine <collection> -w <arWalletFile>

Example

create folder with assets 'mutants' add a collection.json in folder along with the assets drop you wallet.json file in the project folder

npm i @permaweb/machine
npx @permaweb/machine mutants -w ./wallet.json

Docs

  • Your asset files
  • A collection.json file that describes your project
  • (OPTIONAL) A banner.png file to provide a banner for your collection

Here is an example directory structure:

- assets
  - 0.png
  - 1.png
  - 2.png
  - collection.json
  - banner.png

The banner.png file should have dimensions of 1600x900 pixels.

Collection JSON Schema

The collection.json file follows a specific schema to describe your collection. Here are the available properties:

| Property | Description | | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | name | The name of your collection. | | title | The title prefix, which will be appended to the filename. Usually, it is a number. If you want to use the filename as the title, then enter "FILENAME" as the value | | description | The description that you want to appear on the collection and every asset. | | topics | Discoverable topics for your collection. | | licenseTags | Tags to define your license. | | owners | A set of wallet addresses with the numeric amount of units for each wallet. | | genre | The primary genre associated with the track. | | type | The type of asset. | | code | An identifier for your collection. If left blank, a GUID will be created. This enables linking between the collection and manifest file. | | creator | wallet address of the creator |

Example collection.json

{
  "name": "Cyber Raccoon collection",
  "title": "Cyber Raccoon #", 
  "description": "Cyber Raccoon collection",
  "topics": ["cyber", "animals", "permaweb"],
  "licenseTags": {
    "License": "yRj4a5KMctX_uOmKWCFJIjmY8DeJcusVk6-HzLiM_t8",
    "Access": "public",
    "Derivation": "allowed-with-license-fee",
    "Derivation-Fee": "One-Time-0.1",
    "Commercial": "allowed",
    "Commercial-Fee": "One-Time-0.5",
    "Payment-Mode": "Global-Distribution"
  },
  "owners": {
    "vh-NTHVvlKZqRxc8LyyTNok65yQ55a_PJ1zWLb9G2JI": 100
  },
  "genre": "electronic",
  "type": "image",
  "code": "raccoon-collection",
  "creator": "vh-NTHVvlKZqRxc8LyyTNok65yQ55a_PJ1zWLb9G2JI"
}

Please make sure to provide the necessary information in the collection.json file to accurately represent your collection.

Enjoy using The Machine to deploy your collections to the permaweb!