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 02515fe..378984c 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,21 @@ -"THE BEER-WARE LICENSE" (Revision 42): +MIT License - wrote this program. As long as you retain this notice you -can do whatever you want with this stuff. If we meet some day, and you think -this stuff is worth it, you can buy me a beer in return. +Copyright (c) 2017-2025 Jon Michael Aanes - Jon Michael Aanes +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 56dbb14..ab50b5f 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ - - - + + + -Colors +# Colors - This is a collection of functions for performing color operations, designed to work with the LÖVE game engine. +This is a collection of functions for performing color operations, designed to work with the LÖVE game engine. - ## Documentation +## Documentation Supports following color formats: @@ -30,11 +30,9 @@ Hue channel is in the [0-1] range, instead of the standard [0-2*pi] range. interpolate_rgb (c1, c2, t) Interpolation - invert_rgb (color) Inversion - parse_rgb (str) Parsing @@ -42,10 +40,8 @@ Parsing interpolate_rgb (c1, c2, t) - Interpolation - Parameters: c1 @@ -54,43 +50,55 @@ c2 t - - - - invert_rgb (color) - Inversion - Parameters: color - - - - parse_rgb (str) - Parsing - Parameters: str Error handling -# License +## Dependencies + +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. + +This project does not have any library requirements 😎 + +## Contributing + +Feel free to submit pull requests. Please follow the [Code Conventions](CONVENTIONS.md) when doing so. + +## License ``` -"THE BEER-WARE LICENSE" (Revision 42): +MIT License - wrote this program. As long as you retain this notice you -can do whatever you want with this stuff. If we meet some day, and you think -this stuff is worth it, you can buy me a beer in return. +Copyright (c) 2017-2025 Jon Michael Aanes - Jon Michael Aanes +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. ``` diff --git a/init.lua b/init.lua index 13e8796..3ddfca4 100644 --- a/init.lua +++ b/init.lua @@ -1 +1,5 @@ -return require ((...) .. '.colors') +-- WARNING! +-- THIS IS AN AUTOGENERATED FILE! +-- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! + +return require (((...) ~= 'init' and (...) .. '.' or '') .. 'colors')