wookiefriseur/LFC
1
0
Fork 0
mirror of https://github.com/wookiefriseur/LFC.git synced 2026-09-10 00:34:44 +00:00
Code Issues Projects Releases Packages Wiki Activity
LibFurnitureCatalogue https://wookiefriseur.github.io/LFC/
45 commits 1 branch 2 tags 357 KiB
  • Lua 94.1%
  • Python 4.9%
  • Shell 1%
Find a file
Exact
Mat 3dc828678b
 Merge pull request #4 from wookiefriseur/release/1.1.0 
Release 1.1.0
2026-09-08 02:23:49 +02:00
.github pipeline + WIP GH pages 2026-08-31 17:08:59 +02:00
docs add slash commands 2026-09-06 04:17:14 +02:00
LibFurnitureCatalogue Version bumps for 1.1.0 2026-09-08 00:19:05 +00:00
scripts README update + pipeline zip fix 2026-09-08 01:58:54 +02:00
tests test + forgot to commit new Chat.lua, woops 2026-09-07 01:28:56 +02:00
.editorconfig WIP: actions + pipeline 2026-08-31 04:36:02 +02:00
.gitignore pipeline + WIP GH pages 2026-08-31 17:08:59 +02:00
CHANGELOG CHANGELOG for 1.1.0 2026-09-08 00:19:05 +00:00
README.esoui README: reference min version for first bump 2026-09-08 02:13:11 +02:00
README.md pipeline + WIP GH pages 2026-08-31 17:08:59 +02:00
stylua.toml WIP: actions + pipeline 2026-08-31 04:36:02 +02:00

README.md

LibFurnitureCatalogue

Official Furniture Catalogue database library. Used by FurnitureCatalogue.

This repo contains the following:

  1. AddOn src files in ./LibFurnitureCatalogue
  2. hand-maintained DB files in ./LibFurnitureCatalogue/data

Future plans:

  1. helper scripts to build compact DB files from human readable ones
  2. webinterface for contributors and lookups

Release

  • packaged from ./LibFurnitureCatalogue, which is the AddOn as it ships
  • everything else here is tool or webinterface related stuff that stays out of the zip

Releases are done through workflows with automatic version bumps, manual packaging only for plan B:

  1. PrepareRelease (prepare_release.yml), started manually from the Actions tab
  2. FinalizeRelease (finalize_release.yml), triggered by the generated PR being merged
  3. PublishToESOUI (publish_to_esoui.yml), triggered by FinalizeRelease

Both PublishToESOUI and build.sh --publish support an optional dry_run flag, which uses ESOUI test endpoint and does not publish the AddOn.

Tools

  • scripts/build.sh: local equivalent of the GitHub pipeline, zips land in .package/
  • scripts/stylua.sh: formatting with the exact StyLua version CI uses
  • scripts/furc_utils.py: version, manifest and changelog helpers used by the workflows

Website

https://wookiefriseur.github.io/LFC/ - API docs and, later, the webinterface for contributors.

  • served straight from docs/ on main

Tests

  • tests/run_static.sh: syntax (WIP)
  • tests/validate_data.lua: duplication + schema (WIP)

Local setup

lua and luac (or symlinks) go in bin/, which is gitignored. ../bin next to the repo also works. Override with LUAC and LUA, in the environment or in .env at the repo root (tools and tests both read those). See scripts/env.example.

Data validation script is doing nothing for now.