https://github.com/notnite/csgenny

ReGenny scripts for FFXIVClientStructs
https://github.com/notnite/csgenny

Last synced: 4 days ago
JSON representation

ReGenny scripts for FFXIVClientStructs

• Host: GitHub
• URL: https://github.com/notnite/csgenny
• Owner: NotNite
• License: mit
• Created: 2024-01-01T18:17:52.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-01-01T19:45:30.000Z (11 months ago)
• Last Synced: 2024-05-01T17:34:35.953Z (7 months ago)
• Language: Lua
• Size: 29.3 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# csgenny

ReGenny scripts for FFXIVClientStructs.

## Usage

This project uses some Node.js libraries to bundle and minify the scripts:

```shell

npm i

cp config.example.lua config.lua

$EDITOR config.lua

node build.js

```

After loading a project and attaching to FFXIV, select File > Run Lua Script and select a file in the `dist` folder.

## Scripts

### resolver

The resolver converts various bangs in the Address field into their location in memory. You can use the following bangs:

- `instance!` to resolve the instance of a class from data.yml

  - `instance!classname`, e.g. `instance!Client::System::Framework::Framework`

Using this requires [my ReGenny fork](https://github.com/NotNite/regenny/tree/address-resolvers) until my PR is merged.

## Contributing

Please use [StyLua](https://github.com/JohnnyMorganz/StyLua) for formatting (`npm run format`) and [lua-language-server](https://github.com/LuaLS/lua-language-server) for linting and typechecking.