Skip to content

Commit 70a7bd6

Browse files
committed
Update README.md
1 parent 3a62ac5 commit 70a7bd6

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# DFHack Lua API Definitions
22

3-
[![Main branch test status](https://github.com/vallode/dfhack-lua-definitions/actions/workflows/test.yml/badge.svg?branch=main&event=push)](https://github.com/vallode/dfhack-lua-definitions/actions/workflows/test.yml)
3+
[![Main branch test status](https://img.shields.io/github/actions/workflow/status/vallode/dfhack-lua-definitions/.github%2Fworkflows%2Ftest.yml)](https://github.com/vallode/dfhack-lua-definitions/actions/workflows/test.yml)
4+
[![Current release](https://img.shields.io/github/v/release/vallode/dfhack-lua-definitions)](https://github.com/vallode/dfhack-lua-definitions/releases)
45

56
[Lua language server](//github.com/LuaLS/lua-language-server) type definitions for [DFHack](//docs.dfhack.org/en/stable/)'s Lua API.
67

78
Any form of contribution (feedback, criticism, words of encouragement) is welcome. Feel free to open an issue, email, or ping me on the DFHack discord.
89

910
> [!NOTE]
1011
>
11-
> These definitions are work-in-progress, they can lie to you. You can find up to date documentation on the [DFHack website](//docs.dfhack.org/en/stable/docs/dev/Lua%20API.html). That being said, please raise any problems here or on DFHack's Discord server.
12+
> These definitions are work-in-progress, they can lie to you. You can find up to date documentation on the [DFHack website](//docs.dfhack.org/en/stable/docs/dev/Lua%20API.html). That being said, please raise any problems here or on DFHack's [Discord server](//dfhack.org/discord).
1213
1314
## Installation
1415

@@ -64,7 +65,6 @@ Reportedly working but no instructions yet.
6465
## Known issues
6566

6667
- Developing the DFHack lua library with the annotations loaded can be annoying due to "duplicate field" warnings
67-
- DFHack's C++ functions that are exposed to Lue are **not included** (#4)
6868
- Initally opening DFHack can take a long time to load, especially on weaker hardware (#5)
6969
- LuaLS has a known problem with type-hinting inside of files that write to the `_ENV` global, if you are in a file writing to `_ENV` comment out those lines.
7070
- Types defined in C++ headers (like `NoblePosition`) are unsupported

0 commit comments

Comments
 (0)