Getting Started

Installing LilGuy


Install for Windows

The LilGuy installer supports only the 64bit version of Microsoft Windows. Most modern PCs use a 64-bit operating system.

To determine which version of Windows is installed, press the Windows key on the keyboard and then type in About. Click About Your PC in the menu. The System Type listing under Device Specifications will show if the installed version of Windows is 32 or 64-bit.

  1. Download lilguy-0.13-x86_64.msi
  2. In your downloads folder, find lilguy-0.1.3-x86_64 and double-click on the file.
  3. Microsoft will pop up a box saying that Windows protected your PC because the file does not have a publisher as an open-source project. Click on More info.
    4. screenshot showing the Windows Defender SmartScreen dialog box
  4. Click on on Run anyway to install the software.
    5. Screenshot showing the Windows Defender 'Run Anyway' warning box
  5. The LilGuy Setup Wizard should open. Click next.
    6. Screenshot showing the install step

  6. The next page gives licensing information (MIT license).

    Click the checkbox to accept the MIT license for using the software, and then click next.

    7. screenshot showing the accept license step
  7. The next screen is asking where you would like to install LilGuy. You can select the default folder, or use the Browse button to choose a new location. Once you've made your selection, click next.
    8. screenshot showing the select installation folder step
  8. Click Install.
    9. screenshot showing the install step
  9. The User Access Control screen may appear. To install, click Yes.
  10. After installation, you can click Close or Finish on the installer wizard. LilGuy is now installed.

    11. For instructions on starting the LilGuy server, see the usage section.

Uninstall (for Windows)

  1. Open the Add or remove programs tool.

    This can be found by pressing the Windows Key or going to the search bar and typing in Add or remove programs.

  2. In the search bar, type lilguy.
    3. screenshot showing the add/remove programs dialogue box
  3. Click the three dots ... on the right side and select Uninstall from the dropdown menu.
  4. A warning will appear saying the app and its related info will be uninstalled. Click Uninstall.
  5. The User Access Control full-screen menu will appear. To finish uninstalling, click Yes.

Installing For Mac

  1. Download lilguy-0.1.3.pkg
  2. Click on the downloaded "pkg" installer.
  3. This will open the Install LilGuy window. To proceed, click Continue.
    4. screenshot of Mac LilGuy Installer
  4. The next window will show the MIT License for the software. To proceed, click Continue.
    5. screenshot of Mac LilGuy MIT License
  5. A dialog window will appear. To accept the license, click Agree.
    6. screenshot of Mac LilGuy MIT Agreement dialog box
  6. On the Installation Type window, click Install.
    7. screenshot of Mac LilGuy Installation Type
  7. Use Touch ID or click Use Password on the Installer .
    8. screenshot of Mac LilGuy Use Password screen
  8. The final window will confirm that the software has been successfully installed. Click Close or close the window.
    9. screenshot of Mac LilGuy success screen

Uninstall (for Mac)

  1. The LilGuy file can be deleted from the usr/local/bin/lilguy path which will remove the program from the computer.

    2. Other Systems

    Currently, packages for Linux and FreeBSD are available.

    LilGuy packages created by the community will be added to this page as they become available.

Using LilGuy

  1. To start LilGuy for the first time, you need to start it from the terminal.
    • For Windows, open a terminal by pressing Windows key + R to open the Run dialog box and type "cmd", then press Enter. Or type cmd into the Windows search bar and select Command Prompt from the Files and Programs menu.
    • For Mac, open a terminal by clicking the Launchpad icon in the Dock, and type Terminal into the search field, and then click Terminal. Or in Finder, open Applications/Utilities and then double-click on Terminal.
  2. In the new terminal window, enter "lilguy new project-name" and press enter. The words project-name should be replaced with the name of the project.
    3. screenshot of a MacOS terminal showing the lilguy new project-name command
  3. Type cd project-name and press enter. This will move the terminal into the project folder.
    4. screenshot of a MacOS terminal showing the cd project-name command
  4. Type lilguy serve --open into the terminal and press enter.
    5. screenshot of a MacOS terminal showing the lilguy serve --open command
  5. The lilguy serve command will start a new lilguy server, and then the --open flag will automatically open a browser window to view the LilGuy server page.

    A new browser window should open showing the lilguy server default web page which is now running on the computer.
    6. screenshot of a web browser showing the default lilguy server page
  6. The terminal window will stay open and show output from the server as it is running. You can use this to monitor the server and the processes which are communicating with it.
    7. screenshot of a MacOS terminal showing the LilGuy server output

  7. To close the LilGuy process, click into the terminal window and press Ctrl+C on the keyboard. The process will indicate that it is shutting down.

    After the process has completely shut down, the terminal window can be closed.

    If the terminal is closed before the process has ended, the server will also close when the computer is rebooted or shut down. The process can also be closed from the services and processes window.

  8. To create an original LilGuy project, edit the app.lua file that is generated when a new project is created.

    Project examples are available on the LilGuy GitHub page.