Skip to content

Commit 41db905

Browse files
committed
Updated readme
1 parent 195bfb1 commit 41db905

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
11
# DbScriptExtensions
22

3-
## What is DbScriptExtensions?
4-
53
DbScriptExtensions is a Lua framework for the [Eluna Lua Engine ©](https://github.com/ElunaLuaEngine/Eluna) that allows you to create, load, modify and delete database entities via your own Lua code.
64

7-
## How to use DbScriptExtensions
5+
## Table of Contents
6+
7+
- [Installation](#how-to-use-dbscriptextensions)
8+
- [Examples](#examples)
9+
- [Creating a new database object](#creating-a-new-database-object)
10+
- [Get unused primary keys](#get-unused-primary-keys)
11+
- [Loading a database object](#loading-a-database-object)
12+
- [Updating an existing database object](#updating-an-existing-database-object)
13+
- [Delete an existing database object](#delete-an-existing-database-object)
14+
- [FAQ](#faq)
15+
16+
## Installation
817
* Copy the content of this repository to the folder `lua_scripts/extensions/DbScriptExtensions`.
918

1019
To check if you copied it correctly, make sure you find the README file under `lua_scripts/extensions/DbScriptExtensions/README.md`
@@ -61,10 +70,10 @@ existingCreature:Delete() -- Delete row with guid = 123
6170
```
6271

6372
## FAQ
64-
### I see errors in my world server console. What can i do?
73+
### What can i do when i see errors in my world server console?
6574
Set `DbScriptExtensions_PrintQueries = true` in your file `lua_scripts/extensions/DbScriptExtensions/DbScriptExtensions.ext`. Now restart the world server. It should show all DbScriptExtensions SQL queries that it tries to run. Now you can open up an issue on the GitHub repository with the query it tried to execute and a snippet of your code that leads to this error. Make sure to mention which emulator you're using.
6675

67-
### I updated my emulator and database and now i see errors in my world server console. What can i do?
76+
### What can i do when i updated my emulator and database and now i see errors in my world server console?
6877
There were probably some changes in your database because of the update. Try to regenerate the table files by deleting all files under `lua_scripts/extensions/DbScriptExtensions/Mapping` (Do not delete the Mapping folder! Regenerating will fail if you do this!) and setting `DbScriptExtensions_GenerateTableFiles = true` in your file `lua_scripts/extensions/DbScriptExtensions/DbScriptExtensions.ext`. Now you can reload Eluna by typing `reload eluna` into your console or by typing `.reload eluna` ingame. Afterwards set the option back to false and restart your world server. If the error still persists, report the problem as explained in the first question.
6978

7079
### Are all column names case sensitive?

0 commit comments

Comments
 (0)