Skip to content

Commit

Permalink
link fixes and ffmpeg doc added
Browse files Browse the repository at this point in the history
  • Loading branch information
imacodr committed Jan 4, 2025
1 parent da981cc commit 515d896
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/flightpath/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Flightpath = "imacodr/[email protected]"

If you are preferably using Roblox Studio to develop code you can also install our module through the Roblox marketplace.

[Roblox Module](https://create.roblox.com/store/asset/98399377763482/Flightpath?assetType=Model&externalSource=www)
[Roblox Module](https://create.roblox.com/store/asset/98399377763482/Flightpath?assetType=Model&externalSource=www){: target="_blank"}

## with GitHub

You can also install the module from [GitHub releases](https://github.com/imacodr/Flightpath/releases) easily.
You can also install the module from [GitHub releases](https://github.com/imacodr/Flightpath/releases){: target="_blank"} easily.
2 changes: 1 addition & 1 deletion docs/flightpath/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ This module is the Roblox side of Jetstream and enables you to load, play, and m

## GitHub

The source code for Flightpath can be found here: [https://github.com/imacodr/Flightpath](https://github.com/imacodr/Flightpath)
The source code for Flightpath can be found here: [https://github.com/imacodr/Flightpath](https://github.com/imacodr/Flightpath){: target="_blank"}
30 changes: 29 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,35 @@ In this start guide we will guide you through the installation and usage of Jets

You will require Python version 3.12+ & PyPI (Included in Python) to install the CLI tool.

Install Python using this [link](https://www.python.org/downloads/).
Install Python using this [link](https://www.python.org/downloads/){: target="_blank"}.

---

## Install ffmpeg

For our frame splicing to do its work you will need to install a tool called ffmpeg.

You can find info on how to install it on its [website](https://www.ffmpeg.org/download.html){: target="_blank"}

Or if you have a package manager it is recommended to use it:

=== "choco (Windows)"

```sh
choco install ffmpeg
```

=== "homebrew (MacOS)"

```sh
brew install ffmpeg
```

=== "apt (Ubuntu)"

```sh
sudo apt install ffmpeg
```

---

Expand Down
2 changes: 1 addition & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ Frame splicing is not exactly the most efficient method of playing a video as yo

---

Jetstream is maintained and made with :heart: by [imacodr](https://www.roblox.com/users/501780776/profile)
Jetstream is maintained and made with :heart: by [imacodr](https://www.roblox.com/users/501780776/profile){: target="_blank"}
4 changes: 2 additions & 2 deletions docs/settingup.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To publish assets to Roblox we will need to use Roblox's Open Cloud API meaning

**This can be done with either a user or a group (If its a user I recommend creating an alternate account as it will heavily trash your dashboard with frames)**

Start by going to [Roblox Creator Dashboard's API Keys](https://create.roblox.com/dashboard/credentials?activeTab=ApiKeysTab)
Start by going to [Roblox Creator Dashboard's API Keys](https://create.roblox.com/dashboard/credentials?activeTab=ApiKeysTab){: target="_blank"}

![creator dashboard](assets/robloxapidashboard.jpeg)

Expand Down Expand Up @@ -104,7 +104,7 @@ It was quite a lot for our API key, but don’t worry, you’re done with that n
Now its time for us to set the uploader for our frames. This will depend on which type of key you made.

=== "User API Key"
If you made an API key using an user, either your personal account or an alternative one. You will use that user's ID.
If you made an API key using an user account, either your personal account or an alternate one. You will use that user's ID.

Go to your Roblox Profile and look in the URL.

Expand Down

0 comments on commit 515d896

Please sign in to comment.