Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/AlRado/Sublime-TIC-80

package for Sublime Text 3 for TIC-80 game developers
https://github.com/AlRado/Sublime-TIC-80

Last synced: 16 days ago
JSON representation

package for Sublime Text 3 for TIC-80 game developers

Lists

README

        

# Sublime-TIC-80
package for Sublime Text 3 for TIC-80 game developers
TIC-80 API ver.0.40.0

Description
===========

'Sublime TIC-80' is a package for [Sublime Text 3](http://www.sublimetext.com) for TIC-80 game developers. Its based on [BetterLua](https://github.com/Xuerian/Sublime-BetterLua), [Moonscripty](https://github.com/rorydriscoll/LuaSublime) and [JavaScriptNext](https://github.com/Benvie/JavaScriptNext.tmLanguage).
The package highlights and auto-completes the functions of the TIC-80 API, the standard libraries connected to it and Lua/MoonScript syntax. Works either for Lua and for MoonScript.
Also it allows you to build game and run it by the TIC-80 fantasy game console.

Installation
============

These files should be placed into the 'TIC-80' package directory.
For Windows this directory is:

C:\\Users\\[USERNAME]\\AppData\\Roaming\\Sublime Text 3\\Packages\\TIC-80

(Optionally) Disable built-in Lua package to prevent conflicts - remove file 'Lua.sublime-package' from C:\\Program Files\\Sublime Text 3\\Packages\\

Syntax highlighting
-------------------
Command Palette:
Set Syntax: TIC-80 lua
Set Syntax: TIC-80 moon
You can also select the syntax by selecting from the list by clicking on the button in the right-bottom corner of the screen.

Completions
-----------
Autocomplete by pressing TAB after writing the function name.
See all snippets in window Tools -> Snippets. In order to see only API functions write here 'TIC-80 API', to see 'string' library functions write here 'string' and so on.

Build game for TIC-80
---------------------
Edit TIC-80.sublime-build before launch building.
By default, path to TIC-80 is

C:\\Program Files\\TIC-80\\tic.exe

To build your game select build system in window Tools -> Build System -> TIC-80, then press CTRL+B.

In order for the build to run the cartridge, you need to save it next to your file containing the code with the same name.

Sintax files editing
--------------------
1. Install package [PackageDev](https://github.com/SublimeText/PackageDev). You can just copy content of the archive to folder which will be opened by Preferences -> Browse Packages... and restart Sublime Text.
2. Edit syntax files, e.g. for the Lua: Sublime-TIC-80/syntax/lua/TIC-80_Lua.YAML-tmLanguage
3. Select Tools -> Build System -> Convert to...
4. Select Tools -> Build or press CTRL+B to build TIC-80_Lua.tmLanguage file. This file will highlight syntax when proper language selected.

Описание
========

'Sublime TIC-80' это пакет для [Sublime Text 3](http://www.sublimetext.com) предназначенный для разработчиков игр под TIC-80. Он основан на пакетах [BetterLua](https://github.com/Xuerian/Sublime-BetterLua), [Moonscripty](https://github.com/rorydriscoll/LuaSublime) и [JavaScriptNext](https://github.com/Benvie/JavaScriptNext.tmLanguage).
Пакет подсвечивает и автодополняет функции API TIC-80 и подключенные к нему стандартные библиотеки. Работает либо для Lua либо для MoonScript.
Также позволяет создавать билд игры и запускать её в виртуальной игровой консоли TIC-80.

Установка
=========

Эти файлы должны быть размещены в директории пакета 'TIC-80'.
Для Windows, эта директория располагается тут:

C:\\Users\\[USERNAME]\\AppData\\Roaming\\Sublime Text 3\\Packages\\TIC-80

(Опционально) Отключите встроенный пакет Lua для предотвращения конфликтов - перенесите файл 'Lua.sublime-package' из C:\\Program Files\\Sublime Text 3\\Packages\\

Подсветка синтаксиса
--------------------
Command Palette:
Set Syntax: TIC-80 lua
Set Syntax: TIC-80 moon
Также можно выбрать синтаксис выбрав из списка, нажав на кнопку в правом-нижнем углу экрана.

Автодополнение
--------------
Автодополняется по нажатию TAB после написания имени функции.
Смотрите все сниппеты в окне Tools -> Snippets. Чтобы увидеть только функции API, напишите здесь 'TIC-80 API', чтобы увидеть библиотечные функции 'string', напишите здесь 'string', и так далее

Создание билда игры для TIC-80
------------------------------
Отредактируйте файл TIC-80.sublime-build перед запуском создания билда.
По умолчанию путь к TIC-80:

C:\\Program Files\\TIC-80\\tic.exe

Для создания билда игры выберите Tools -> Build System -> TIC-80, затем нажмите сочетание клавишь CTRL+B.

Для того чтобы при билде игры запустился картридж, нужно сохранитиь его рядом с Вашим файлом содержащим код с тем же именем.

Редактирование файлов синтаксиса
--------------------------------
1. Установите пакет [PackageDev](https://github.com/SublimeText/PackageDev). Можно просто скопировать содержимое его архива в папку которая откроется выбрав Preferences -> Browse Packages.. и перезапустить Sublime Text.
2. Отредактируйте файлы синтаксиса, например для Lua: Sublime-TIC-80/syntax/lua/TIC-80_Lua.YAML-tmLanguage
3. Выберите Tools -> Build System -> Convert to...
4. Выберите Tools -> Build либо нажмите CTRL+B, будет подготовлен файл TIC-80_Lua.tmLanguage, который и будет подсвечивать синтаксис при выборе соответствующего языка.