Asphalt is a command line tool used to upload assets to Roblox and easily reference them in code. It's a modern alternative to Tarmac.
- Syncs your images, sounds, models, and animations to Roblox
- Generates Luau or Typescript code so you can use them in your game
- Can target Roblox users or groups
- Processes SVGs into PNGs and alpha bleeds images for crisp edges
- Allows defining existing uploaded assets, so all of your stuff can be referenced in one place
- Capablility to pack your images into spritesheets for lower client memory usage
Homebrew (macOS/Linux)
brew tap jacktabscode/tap
brew install asphaltpesde add --dev pesde/asphalt --target luneaftman add jacktabscode/asphaltCargo (build from source)
cargo install asphaltAsphalt cannot be installed with Foreman.
Syncs all of your assets defined in your inputs.
There are three targets you can use to sync assets:
-
cloud: Uploads your assets to Roblox. This will generate aasphalt.lock.tomlfile which you should commit to source control. This is the default target. -
studio: Syncs assets locally to Roblox Studio. This is useful for testing assets in Studio before uploading them to Roblox. -
debug: Syncs assets to an.asphalt-debugfolder in the current directory. You can use this option see how Asphalt will process your files.
asphalt sync # Equivalent to --target cloud
asphalt sync --target studio
asphalt sync --target debugYou can also perform a dry run to verify which assets will be synced. This exits with a non-zero status code if any asset hashes have changed. You can use this for CI checks to ensure that your assets are up-to-date.
asphalt sync --dry-runWill migrate over a pre-1.0 lockfile to the new format. See asphalt migrate-lockfile --help for more information.
Uploads a single asset to Roblox. See asphalt upload --help for more information.
Asphalt is configured with a project file called asphalt.toml. It is required for the program to run.
Example
[creator]
type = "user"
id = 9670971
[codegen]
typescript = true
style = "flat"
[inputs.assets]
path = "assets/**/*"
output_path = "src/shared"
[inputs.assets.web]
"some_sound_on_roblox.ogg" = { id = 123456789 }
"some_image_on_roblox.png" = { id = 987654321 }creator: Creator- The Roblox creator to upload the assets under.
codegen: Codegen- Code generation options.
inputs: map<string, Input>- A map of input names to input configurations.
type: "user" or "group"id: number
typescript: boolean (optional)- Generate a Typescript definition file.
style: "flat" | "nested" (optional)- The code-generation style to use. Defaults to
flat, which makes accessing assets feel like writing file paths. You may consider usingnestedif you are not a TypeScript user, however, as Luau does not support template literal types.
- The code-generation style to use. Defaults to
strip_extensions: boolean (optional)- Whether to strip the file extension. Defaults to
falsefor the same reason described above.
- Whether to strip the file extension. Defaults to
path: glob- A glob pattern to match files to upload.
output_path: string- The directory path to output the generated code.
web: map<string, WebAsset>- A map of paths relative to the input path to existing assets on Roblox.
id: number
The formatting of code generation (such as spaces, tabs, width, and semicolons) is not guaranteed by Asphalt and may change between releases without being noted as a breaking change.
Therefore, it is recommended to add Asphalt's generated files to your linter/formatter's "ignore" list. Here are instructions for the most commonly used tools:
You will need an API key to sync with Asphalt. You can specify this using the --api-key argument, or the ASPHALT_API_KEY environment variable.
You can get one from the Creator Dashboard.
The following permissions are required:
asset:readasset:writelegacy-asset:manage
You will need a cookie to upload animations to Roblox. This is because the Open Cloud API does not support them. It will automatically detected from the current Roblox Studio installation. Otherwise, you can specify this using the --cookie argument, or the ASPHALT_COOKIE environment variable.
You will probably want to disable Session Protection if you are using Asphalt in an environment where your IP address changes frequently, but we don't recommend this on your main Roblox account, as it makes your account less secure.
Warning
This feature is experimental, and Roblox may break the API we use or change its behavior without warning.
To upload animations, make sure you specify a cookie as noted above.
Asphalt expects a single KeyframeSequence to be saved as either a .rbxm or .rbxmx file.
Thank you to Tarmac for the alpha bleeding and nested codegen implementations, which were used in this project.