https://github.com/hazzard993/love-ts
A tool for managing TypeScript LOVE 2D projects
https://github.com/hazzard993/love-ts
love2d lua typescript
Last synced: 2 months ago
JSON representation
A tool for managing TypeScript LOVE 2D projects
- Host: GitHub
- URL: https://github.com/hazzard993/love-ts
- Owner: hazzard993
- Created: 2019-08-02T03:50:13.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-04-28T23:27:20.000Z (about 4 years ago)
- Last Synced: 2025-03-28T21:43:39.710Z (about 1 year ago)
- Topics: love2d, lua, typescript
- Language: Lua
- Size: 69.3 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
LOVE TS
A command line tool to manage and release LÖVE 2D TypeScript projects.
Requires [LÖVE 2D](https://love2d.org/), NPM (installed via [Node.js](https://nodejs.org/)) and [Yarn](https://yarnpkg.com/).
`love`, `npm` and `yarn` should all be executable within a console.
LOVE TS is available via NPMJS.
```
yarn global add love-ts
```
Upon installation `love-ts` should now be available via the CLI.
```
love-ts help
```
## Features
- One command to start a project. (`love-ts start` or `love-ts .`)
- Errors are traced back to their original TypeScript source files.
- One command to start, watch and dynamically update a running LÖVE 2D project with updating TypeScript code. (`love-ts watch`)
- Can initialize a skeleton project within a directory. (`love-ts init`)
- Can initialize an even smaller project with typing information only. (`love-ts init --typings`)
- One command to bundle output Lua files, resources and even _dependencies_ into an output _.love_ file. (`love-ts release`)
- Can package projects as libraries for other projects. (`love-ts release --library`)
- Lua libraries can be installed to _node\_modules_ from GitHub and immediately be used in the project.
- Can type-check and run projects without installing their dependencies.
## Creating a Project
```sh
love-ts init
love-ts init --typings
```
## Running a Project
```sh
love-ts start
love-ts .
love-ts /path/to/project
```
## Watching a Project
```sh
love-ts watch
```
## Releasing a Project
```sh
love-ts release
love-ts release --library
```
## Resources
Resource files should be placed into the _res/_ folder.
```diff
res/
+ image.png
src/
main.ts
```
**main.ts**
```ts
love.graphics.newImage("res/image.png");
```