Skip to content

NikitaIvanovV/atom-tic80

Repository files navigation

atom-tic80

Make and run TIC-80 games in Atom


  • Allows you to run and make games within Atom
  • Prints TIC's console output in Atom's terminal
  • Provides autocompletion, datatips, syntax highlighting and snippets for TIC's API

Showcase

Table of Contents

Requirements

Installation

Either run command:

  • apm install atom-tic80

Or:

  1. Go to Atom > Settings > Install
  2. Search for atom-tic80
  3. Click "Install"

Usage

All commands can be ran via Command Palette. If you open it by pressing Ctrl+Shift+P and type tic80, you will see all the available commands.

Run

Tic80: Run command simply runs TIC-80.

Although, it's not that simple because Atom needs to know how to run it. Try out the command: if it fails, go to the package settings and set the proper path to your TIC-80 executable file.

Run file

Running code files

By using Tic80: Run File you can make your games right in Atom! Write some code, save it with .lua extension (or whatever TIC-80 supports) and press Ctrl+R (the command has a handy keybinding!).

After running the command, the essential cartridge metadata will be added at the top of your file if it's not already present.

Running cart files

The same command can also run .tic files. However, it's not recommended to edit them using Atom (or any other external text editor) because chances are this action will corrupt the files.

Project

With Tic80: Create Project command you can pick a folder, choose a language and create a code file in it. The file will be opened in a new window.

Terminal

The package can print TIC-80 console output to a terminal within Atom. You can tweak its behavior and properties in the package settings. There are also some commands to control the terminal, such as Tic80: Show Terminal.

Terminal

Autocompletion, datatips, snippets and highlighting

The package also includes some neat features that might make the game creation process a little bit easier.

Note: these features function only if you have your current file grammar set to TIC-80 version. It's done to prevent them from working in regular code when you don't actually make games for TIC-80. Usually the grammar is set automatically but if it's not, just set it yourself.

Set Tic-80 grammar manually

Autocomplete

Start typing any function from TIC's API and Atom will autocomplete it for you.

Autocomplete

Datatips

Hover your mouse over any TIC-80 API function and you will see its description and parameters.

Datatips

Changelog

Changelog can be found in the CHANGELOG file or on GitHub.

License

This project is licensed under the terms of MIT license, See the LICENSE file for more info.