diff --git a/.gitea/workflows/lua-library.yml b/.gitea/workflows/lua-library.yml index ae19cc0..363ae97 100644 --- a/.gitea/workflows/lua-library.yml +++ b/.gitea/workflows/lua-library.yml @@ -1,8 +1,29 @@ +# WARNING! +# THIS IS AN AUTOGENERATED FILE! +# MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! + name: LÖVE/Lua Library -on: [push] + +on: + push: + paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md'] jobs: - Test: - uses: jmaa/workflows/.gitea/workflows/lua-testing.yaml@v6.21 + Lua-Testing: + runs-on: ubuntu-latest + steps: + - name: Install Lua + run: | + apt-get update + apt-get install -y luajit + - name: Check out repository code + uses: actions/checkout@v3 + - name: Run testing library + run: luajit test/init.lua Static-Analysis: - uses: jmaa/workflows/.gitea/workflows/lua-static-analysis.yaml@v6.21 + runs-on: ubuntu-latest + steps: + - name: Check out repository code + uses: actions/checkout@v3 + - name: Luacheck linter + uses: https://github.com/lunarmodules/luacheck@v1.1.1 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..451354e --- /dev/null +++ b/.gitignore @@ -0,0 +1,19 @@ +# WARNING! +# THIS IS AN AUTOGENERATED FILE! +# MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! + +# Löve: Exclude build items +/bin/ +/lib/ +.love-cache/ + +# Compiled Lua sources +luac.out + +# Misc (Image, MacOS, Backups) files +*.psd +*~ +.DS_Store + +# Tools +*.tiled-session diff --git a/.luacheckrc b/.luacheckrc index 277f930..6149112 100644 --- a/.luacheckrc +++ b/.luacheckrc @@ -1,3 +1,7 @@ +-- WARNING! +-- THIS IS AN AUTOGENERATED FILE! +-- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! + std = "love+max" cache = true include_files = {"**.lua", "*.luacheckrc"} diff --git a/LICENSE b/LICENSE index 6e549e7..2506d83 100644 --- a/LICENSE +++ b/LICENSE @@ -1,3 +1,3 @@ -Copyright (c) 2018-2024 Jon Michael Aanes +Copyright (c) 2018-2025 Jon Michael Aanes All rights reserved. diff --git a/README.md b/README.md index 11328e6..9ef2d02 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,25 @@ - - - + + + -# Spritesheet +# Checks that LÖVE is defined; if not, run in information loading -Library for managing sprite sheets of textures and animations. +mode only. -Has support for both individual images in spritesheets and animations. This -can be specified from a lua file placed beside the spritesheet image file. +## Dependencies -## Notes +This project requires [PUC Lua 5.1](https://www.tecgraf.puc-rio.br/lua/mirror/versions.html#5.1) or [LuaJIT](https://luajit.org/luajit.html). Newer versions of PUC Lua are not supported. -- When drawing an image or animation when a shader is defined the library may - send certain useful constants along, notably `spritesheet_inverse_width` and - `spritesheet_inverse_height`. +This project does not have any library requirements 😎 -# License +## Contributing + +Feel free to submit pull requests. Please follow the [Code Conventions](CONVENTIONS.md) when doing so. + +## License ``` -Copyright (c) 2018-2024 Jon Michael Aanes +Copyright (c) 2018-2025 Jon Michael Aanes All rights reserved. ``` diff --git a/init.lua b/init.lua index d2b2e9d..7b96537 100644 --- a/init.lua +++ b/init.lua @@ -1 +1,6 @@ -return require ((...) .. '.spritesheet') +-- WARNING! +-- THIS IS AN AUTOGENERATED FILE! +-- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! + +-- This file automatically redirects to "spritesheet.lua" +return require (((...) ~= 'init' and (...) .. '.' or '') .. 'spritesheet')