Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
mrtwidget committed Apr 16, 2017
1 parent bcdbdfd commit 2743796
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Expand Up @@ -6,14 +6,15 @@
1. Compile project
2. Copy `Livemap.dll` to Unturned rocket plugin directory
3. Start/stop server to generate config and configure MySQL database
4. Add Rocket permission for `/livemap` command to Permissions.config.xml
4. Add Rocket permission for `/livemap` command to `Permissions.config.xml`
- *Example*: `<Permission Cooldown="0">livemap</Permission>`
5. Restart Server

***API***
1. Edit `www/api/config.api.php` and configure MySQL database connection settings
2. Send GET request to `www/api/livemap.api.php?livemap=server_id` returns JSON-encoded response
2. Send GET request to `www/api/livemap.api.php?livemap=server_id` for JSON-encoded response

- *Filtering Results*
**Filtering Results**
Filtering is accomplished by specifying a table name with `filter`. A null `filter` returns all livemap table results.
- *Example*
- *URI*: `?livemap=server_id&filter=livemap_data`
Expand Down

0 comments on commit 2743796

Please sign in to comment.