Skip to content

Commit 71d9c98

Browse files
committed
Update readme
1 parent 78f8860 commit 71d9c98

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
# Asphalt
22

3-
Asphalt is a simple CLI tool used to upload assets to Roblox and easily reference them in code.
3+
Asphalt is a command line tool used to upload assets to Roblox and easily reference them in code.
4+
It's my spiritual successor to [Tarmac](https://github.com/Roblox/Tarmac).
45

56
## Features
67

7-
- Upload images, SVGs, sounds, models, and animations to Roblox
8-
- Generate Luau code to reference the uploaded assets
9-
- Generate Typescript definitions for roblox-ts users
10-
- Uses the Open Cloud API
11-
- Supports uploading to groups
12-
- Define existing uploaded assets, so all of your stuff can be referenced in one place
13-
- Alpha bleeds images for crisp edges when scaled
8+
- Syncs your images, sounds, models, and animations to Roblox
9+
- Generates Luau or Typescript code so you can use them in your game
10+
- Can target Roblox users or groups
11+
- Processes SVGs into PNGs and alpha bleeds images for crisp edges
12+
- Allows defining existing uploaded assets, so all of your stuff can be referenced in one place
13+
14+
## Features Coming Soon
15+
- Capablility to pack your images into spritesheets for lower client memory usage
16+
- Extended support for different audio formats
1417

1518
## Installation
1619

@@ -154,7 +157,7 @@ You can get one from the [Creator Dashboard](https://create.roblox.com/dashboard
154157
## Cookie
155158
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.
156159

157-
You will probably want to [disable Session Protection](https://create.roblox.com/settings/advanced) if you are using Asphalt in an environment where your IP address changes frequently.
160+
You will probably want to [disable Session Protection](https://create.roblox.com/settings/advanced) 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.
158161

159162
## Animations
160163

0 commit comments

Comments
 (0)