Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed .DS_Store
Binary file not shown.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
site/
.DS_Store
Binary file removed docs/.DS_Store
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/tutorials/install/extension1.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/tutorials/install/extension2.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/tutorials/install/extension3.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/tutorials/install/run-l5.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/tutorials/install/stop-l5.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
148 changes: 139 additions & 9 deletions docs/download/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,152 @@

L5 is free open source software available for Linux, Mac, Windows, Android and iOS.

L5 programs run using LÖVE (also called Love2d), a free, open-source framework. Love2d is a game framework, just like Godot, Unity, or Unreal. You will use Love2d to run your L5 scripts. This is similar to using a browser to run HTML code.
L5 programs run using LÖVE (also called Love2d), a free, open-source framework. Love2d is a game framework, just like Godot, Unity, or Unreal, which provides support for graphics, audio and other parts used by L5. You will use Love2d to run your L5 scripts. This is similar to using a browser to run HTML code.

Covered by this download tutorial:

- Download and Install Love2d
- Download and Open L5 Starter Folder
* Download and Install a text editor
* Download and Install Love2d
* Download and Open L5 Starter Folder

### Step-by-step install guides
## Step-by-step install guides

* [macOS](install-mac.md)
* [Windows](install-windows.md)
* [Linux](install-linux.md)
### Install text editor

Congratulations! You've now installed Love and have L5 on your computer and verified you can run your own programs.
We will first need a text editor, which is where we write the actual L5 code on our computer. For those starting out, we suggest downloading [VSCodium](https://vscodium.com/) or [Visual Studio Code (VS Code)](https://code.visualstudio.com/), available for macOS, Windows and Linux. But any preferred text editor is fine.

Now your computer you are ready to write and [run your L5 programs](running.md).
**Note**: If you use iCloud, VSCodium will have significant lag and it is recommended to install VS Code instead.

IDEs such as ZeroBrane Studio, Sublime Text, Notepad++, and SciTE all support launching LÖVE programs (the engine to run our L5 scripts), though require additional setup configuration not covered here.

#### Install L5lua Extension for VSCodium / VS Code

If you have VSCodium or VS Code code editor, open the editor.

Click to open the extensions tab. Search for *L5* and install the extension.

![Open the extension menu on the left side and search L5 on the top](/assets/tutorials/install/extension1.webp "Open the extension menu on the left side and search L5 on the top")

![Search for L5 in the search bar](/assets/tutorials/install/extension2.webp "Search for L5 in the search bar")

![Press install](/assets/tutorials/install/extension3.webp "Press install")


### Install Love2d

L5 uses the Love framework to power its library. There are current installation instructions for [macOS](install-mac.md), [Windows](install-windows.md), and [Linux](install-linux.md).

=== "Install Windows"

This tutorial walks you through installing L5 with the Love (Love2d) framework on your Windows computer.

1. Go to the [Love website](https://love2d.org) and click to download the 64-bit zipped Windows program.
2. Your browser may show a warning. Click **"Keep"** or **"Save anyway"** to proceed with the download. It will download to your _Downloads_ folder by default.
3. From the L5lua.org Download page, [download the L5 Starter project](/L5-starter.zip).
4. Click **"Save"** when it asks you to save the L5-starter.zip file.
5. Return to your _Downloads_ folder on your computer. **Right click** on the Love zip file and choose **"Extract All"**. Click **"Extract"** to extract it to your Downloads folder.
6. Open the extracted Love folder and **double-click** the **love.exe** application to run it. Windows may show a security warning saying "Windows protected your PC". Click **"More info"** and then click **"Run anyway"**.
7. You should see a window open with a flying bird-shaped balloon and clouds, verifying that Love is now properly installed on your computer. **At this point you can close the window.**
8. Go to your *Downloads* folder and **right click** on the L5-Starter.zip file and click to **"Extract"**.

=== "Install macOS"

This tutorial walks you through installing L5 with the Love (Love2d) framework on your Macintosh computer.

**Video Tutorial**

<a href="https://www.youtube.com/watch?v=Ehs-fLQ5gfk" id="yt"><img src="/assets/tutorials/install/youtube.webp" width="560" height="315" alt="Play video"></a>

**Text and Screenshot Tutorial**

1. Love is the underlying Framework that will allow L5 code to run on your computer. Go to the [Love website](https://love2d.org) and click to download the 64-bit zipped Mac program.
![Love2d website with downloads](/assets/tutorials/install/mac1.webp 'Love2d website with downloads')
2. Click **"Allow"** if it asks 'Do you want to allow downloads on "love2d.org"?' It should download to your _Downloads_ folder by default.
![Alert box asking permission to download Love2d](/assets/tutorials/install/mac2.webp 'Alert box asking permission to install Love2d')
3. Now on your desktop (called "Finder" on macOS) open up your _Downloads_ folder. You can right click and choose Open (see screenshot) or double click on Love to launch it.
![Folder with love application and L5 Starter folder](/assets/tutorials/install/mac3.webp 'Folder with love application and L5 Starter folder')
4. A warning popup box opens to say the program and code is not verified by Apple. **DO NOT** move to the trash.
![Alert box stating macOS cannot verify the developer of love. The correct option is Open.](/assets/tutorials/install/mac4.webp 'Alert box stating macOS cannot verify the developer of love. The correct option is Open')
5. Go to your computer's System Settings > Privacy &amp; Security. Scroll down to the **Security** section and next to **"love" was blocked to protect your Mac.** choose **Open Anyway**.
![System settings showing the Privacy and Security settings. Scroll down to Security and next to "love" was blocked to protect your mac, click to "Open Anyway".](/assets/tutorials/install/mac5.webp 'Alert box stating macOS cannot verify the developer of love. The correct option is Open')
6. Now go back to your Downloads folder and **Double click** on Love. We only need to do this once! It's to verify Love works on your computer, which will allow L5 to run your custom code. You should see a window open with a flying bird-shaped balloon and clouds, verifying that Love is now properly installed on your computer. **At this point you can close the window.** Usually on a Mac we place our applications into the Applications folder, so you may want to move it there.
![A flying bird-shaped balloon and cartoon clouds](/assets/tutorials/install/mac6.webp 'A flying bird-shaped balloon and cartoon clouds')
7. From the L5lua.org Download page, [download the L5 Starter project](/L5-starter.zip).
![L5 website download page with L5 Starter](/assets/tutorials/install/mac7.webp "L5 website download page with L5 Starter")
8. Click **"Allow"** if it asks 'Do you want to allow downloads on "l5lua.org"?'
![Alert box asking permission to download L5-Starter](/assets/tutorials/install/mac8.webp "Alert box asking permission to download L5 Starter")

=== "Install Linux"

This tutorial walks you through installing L5 with the Love (Love2d) framework on your Linux computer.

On Linux, installation through the command line is common, but it can also be downloaded through the Love website. Since Linux is an open source family of operating systems the exact process may need to be altered for your particular Linux distribution.

Installing Love differs based on which Linux distribution you have.

**Simplest method: Installing Love through the web browser**

Visit the [Love website](https://love2d.org/) and download the Linux AppImage. This is a format to allow the installation of Linux software that is independent of specific distribution methods. Once downloaded you may have to right click and choose *Properties* and then select *Executable as Program* if this is not already checked. The exact method or wording can vary by Linux distribution. Then double click on Love. We only need to do this once! It's to verify Love works on your computer, which will allow L5 to run your custom code. You should see a window open with a flying bird-shaped balloon and clouds, verifying that Love is now properly installed on your computer. **At this point you can close the window.**

*Alternatively, if you are accustomed to using your Linux distribution's package manager, you can install through the command line:*

**Installing Love on Debian/Ubuntu-based distributions with apt**

```sh
sudo add-apt-repository ppa:bartbes/love-stable
sudo apt update
sudo apt install love
```

**Install Love on Arch-based distributions with Pacman**

```sh
sudo pacman -S love
```

**Installing Love on Red Hat/Fedora/CentOS**

```sh
sudo dnf install love
```

**Installing Love on Void Linux**

```sh
sudo xbps-install -S love
```

**Additional options for installing Love**

Love can also be found in the package manager for [most other distributions](https://repology.org/project/love/versions), including BSD and Haiku OS, or installed via [FlatPak](https://flathub.org/en/apps/org.love2d.love2d), or built from source. See the [Love2d](https://love2d.org) website or check your package manager for more information.

**Download the L5 Starter project**

You can download the [L5 Starter](https://l5lua.org/L5-starter.zip) (right click -> choose Save As) or from the command line by navigating to the directory where you'd like to save the L5-Starter folder:

```sh
cd path/to/folder
wget https://l5lua.org/L5-starter.zip
```

Uncompress it

```
unzip L5-starter.zip
```

<script>
document.getElementById('yt').addEventListener('click', function(e) {
e.preventDefault();
this.outerHTML = '<iframe width="560" height="315" src="https://www.youtube.com/embed/Ehs-fLQ5gfk?autoplay=1" allow="autoplay" allowfullscreen></iframe>';
});
</script>

Congratulations! You've now installed Love and have the L5 Starter on your computer.

**Next, see how to [run your L5 programs](running.md).**

You can also download the L5 source code and the offline documentation below.

### Source code

Expand Down
44 changes: 17 additions & 27 deletions docs/download/install-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,49 @@

This tutorial walks you through installing L5 with the Love (Love2d) framework on your Linux computer.

On Linux, installation through the command line is common. Since Linux is an open source family of operating systems the exact process may need to be altered for your particular Linux distribution.

## Install Love
On Linux, installation through the command line is common, but it can also be downloaded through the Love website. Since Linux is an open source family of operating systems the exact process may need to be altered for your particular Linux distribution.

Installing Love differs based on which Linux distribution you have.

### Install Love on Debian/Ubuntu-based distributions
**Simplest method: Installing Love through the web browser**

Visit the [Love website](https://love2d.org/) and download the Linux AppImage. This is a format to allow the installation of Linux software that is independent of specific distribution methods. Once downloaded you may have to right click and choose *Properties* and then select *Executable as Program* if this is not already checked. The exact method or wording can vary by Linux distribution. Then double click on Love. We only need to do this once! It's to verify Love works on your computer, which will allow L5 to run your custom code. You should see a window open with a flying bird-shaped balloon and clouds, verifying that Love is now properly installed on your computer. **At this point you can close the window.**

*Alternatively, if you are accustomed to using your Linux distribution's package manager, you can install through the command line:*

**Installing Love on Debian/Ubuntu-based distributions with apt**

```sh
sudo add-apt-repository ppa:bartbes/love-stable
sudo apt update
sudo apt install love
```

### Install Love on Arch Linux
**Install Love on Arch-based distributions with Pacman**

```sh
sudo pacman -S love
```

### Install Love on Red Hat/Fedora/CentOS
**Installing Love on Red Hat/Fedora/CentOS**

```sh
sudo dnf install love
```

### Install Love on Void Linux
**Installing Love on Void Linux**

```sh
sudo xbps-install -S love
```

### Additional options to install Love
**Additional options for installing Love**

Love can also be found in the package manager for [most other distributions](https://repology.org/project/love/versions), including BSD and Haiku OS, or installed via [FlatPak](https://flathub.org/en/apps/org.love2d.love2d), or as a portable AppImage or built from source. See the [Love2d](https://love2d.org) website or check your package manager for more information.
Love can also be found in the package manager for [most other distributions](https://repology.org/project/love/versions), including BSD and Haiku OS, or installed via [FlatPak](https://flathub.org/en/apps/org.love2d.love2d), or built from source. See the [Love2d](https://love2d.org) website or check your package manager for more information.

## Download the L5 Starter project
**Download the L5 Starter project**

Navigate to the directory where you'd like to save the L5-Starter folder and download the L5-Starter
You can download the [L5 Starter](https://l5lua.org/L5-starter.zip) (right click -> choose Save As) or from the command line by navigating to the directory where you'd like to save the L5-Starter folder:

```sh
cd path/to/folder
Expand All @@ -53,21 +57,7 @@ Uncompress it
unzip L5-starter.zip
```

## To run your program

Navigate to your L5-Starter directory

```sh
cd /path/to/L5-starter
```

And run your program

```sh
love .
```
Congratulations! You've now installed Love and have the L5 Starter on your computer.

It should now launch and you should see a new window open with your code sketch running.
<img src="/assets/tutorials/install/linux1.webp" alt="A yellow background window appearing on top of folder holding L5 Starter and love application" title="A yellow background window appearing on top of folder holding L5 Starter and love application" width="600" />

**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out other ways to [run your own programs](running.md).
**Next, see how to [run your L5 programs](running.md).**
Loading