Skip to content

Latest commit

 

History

History
165 lines (110 loc) · 6.27 KB

readme.md

File metadata and controls

165 lines (110 loc) · 6.27 KB
Raw

Welcome to assetup 👋

"A robust Asset Uploader CLI for Roblox, written in JavaScript."

Table of Contents

  1. Overview
  2. Features
  3. Prerequisites
  4. Installation
  5. Usage
  6. Configuration
  7. Contributing
  8. License
  9. Support
  10. Authors

Overview

assetup is a robust command-line interface program designed specifically for Roblox, written in JavaScript. The primary purpose of this tool is to enable bulk uploading of assets onto Roblox, using nothing but an open cloud key. Currently, assetup supports only image uploads, but future iterations will extend this functionality to accommodate a multitude of asset types.

Features

  • Command-line interface: Easy-to-use command-line interface that is compatible with most operating systems.
  • Multi-format support: Supports a wide range of asset formats.
  • Customizable: You can configure the tool according to your preferences and requirements.

Prerequisites

Before installing assetup, make sure you have the following installed on your machine:

Installation

To install assetup, simply run the following command:

npm install assetup -g

This command installs assetup globally on your machine, allowing you to run it from any location. Alternatively, you can use npx to run it like if you don't want to install it globally.

  npx assetup [command] [options]

Usage

Upload Images:

Use the upload command to upload images.

    assetup upload [options]

This command uploads images to Roblox from a specified directory and provides you with asset IDs. Available options allow you to customize the input and output directories, and the upload method.

Options:

  • --i, --input <path>: Specifies the directory path containing the PNG image files to be uploaded (default: input)
  • --o, --output <file>: Specifies the output file path for storing asset information (default: output.txt)
  • --m, --method <value>: Selects the upload method: 'both', 'image', or 'decal' (default: 'image')

By default, the script will upload PNG image files from the input directory, generate an output file output.txt, and use the 'both' method to retrieve both asset IDs and image IDs. You can customize these settings according to your needs.

Example usage:

    assetup upload --i assets --o output.txt --m image

Help:

Use the help command to view the help menu.

    assetup help [command]

This command provides information about the available commands and their options. If you use it with a specific command, it gives you detailed information about that command. If no command is provided, it displays the general help menu.

Version:

Use the version command to display the version information.

    assetup version

This command shows the version of the CLI.

Configuration

assetup uses a configuration file to store the necessary API key and other options. Before running the script, you need to set up the configuration by executing the following command:

    assetup config --creator [user/group] --apiKey [apiKey] --groupId [groupId] --userId [userId] --getAssetIdRetryCount [number] --uploadAssetRetryCount [number] --getImageIdRetryCount [number]

Configuration options:

  • Creator: Set the creator type. Default is 'user'.
    • Accepts: 'user', 'group'
    • Keys: --creator, -c, --Creator
  • API Key: Set the API key for authentication. You can generate an API key by following these steps:
  1. Go to the Roblox Developer Dashboard.
  2. Click on "New API Key" to create a new API key.
  3. Enter a unique name for your API key in the "Name" field.
  4. Optionally, enter a description for your API key in the "Description" field.
  5. Add the "Assets API" System in the "Access Permissions" section to the API key.
  6. Configure the access permissions for your API key. Make sure to grant the Read and Write permissions for the asset API to perform the desired actions. You can refer to the Managing API Keys tutorial for detailed instructions on managing API keys.
  7. Specify the accepted IP addresses under the "Accepted IP Addresses" section. You can enter 0.0.0.0/0 to accept requests from any IP address.
  8. Set the expiration date for the API key if desired.
  9. Click "Create" to generate the API key.
  10. Copy the generated API key and use it as the value for the --apiKey option in the assetup config CLI commands.
  • Keys: --apiKey, -k, --apikey, --api-key, --key
  • Group ID: Set the group ID if the creator type is 'group'. Default is empty.
    • Keys: --groupId, --groupid, --group-id, --group
  • User ID: Set the user ID if the creator type is 'user'. Default is empty.
    • Keys: --userId, --userid, --user-id, --user
  • Get Asset ID Retry Count: Set the number of retries for getting the asset ID. Default is 3.
    • Keys: --getAssetIdRetryCount, --get-asset-id-retry-count, --garc
  • Upload Asset Retry Count: Set the number of retries for uploading an asset. Default is 3.
    • Keys: --uploadAssetRetryCount, --upload-asset-retry-count, --uarc
  • Get Image ID Retry Count: Set the number of retries for getting the image ID. Default is 3.
    • Keys: --getImageIdRetryCount, --get-image-id-retry-count, --giirc

Example usage:

assetup config --creator group --apiKey OPEN_CLOUD_KEY --groupId GROUP_ID

This sets the configuration options to the provided values.

To view the current configuration, you can run the following command:

    assetup config

This will display the current configuration values.

Contributing

We welcome contributions, issues, and feature requests! Feel free to check the issues page and contribute.

License

This project is licensed under the GNU License - see the LICENSE file for details.

Show your support

Give a ⭐️ if this project helped you!

Authors

👤 Jerse1