@hokkiai/djs-level-importer 1.1.1 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
<br><h1>Discord Level Importer</h1>
|
|
3
3
|
<br>An open, JavaScript-based library for importing leveling data from MEE6 and other bots.<br>
|
|
4
|
-
<br><br><a href="https://www.hokki.app"><img height="
|
|
4
|
+
<br><br><a href="https://www.hokki.app"><img height="100" src="https://raw.githubusercontent.com/hokkiai/djs-level-importer/refs/heads/master/assets/sokoraXhokki.png?raw=true"></a>
|
|
5
5
|
<br>Made jointly by the <a href="https://sokora.org">Sokora</a> and <a href="https://www.hokki.app">Hokki</a> Discord bots.
|
|
6
6
|
</div>
|
|
7
7
|
<br>
|
|
8
8
|
<br>
|
|
9
|
-
<br>
|
|
10
9
|
|
|
11
10
|
## Usage
|
|
12
11
|
|
|
@@ -65,15 +64,16 @@ This interface division is not the most intuitive, but the best thing we can do
|
|
|
65
64
|
|
|
66
65
|
## Bot support
|
|
67
66
|
|
|
68
|
-
As of now, MEE6, Lurkr, and
|
|
67
|
+
As of now, MEE6, Lurkr, Tatsu and Amari are supported. Most bots don't document their APIs and it's therefore difficult to add new bots, so no guarantees are made; however we do try to add new bots to this library. You can check `TODO.txt` at the root of this repo for a list of planned (or discarded) bots, and you may suggest any bot you know about that isn't listed there by opening an issue.
|
|
69
68
|
|
|
70
|
-
**Bots are selected using integers** when calling `GetLeaderboard`. You can check
|
|
69
|
+
**Bots are selected using integers** when calling `GetLeaderboard`. You can check integer-bot associations by looking at the exported `SupportedBots` TypeScript enum. Or just look at it here:
|
|
71
70
|
|
|
72
71
|
```ts
|
|
73
72
|
export enum SupportedBots {
|
|
74
73
|
MEE6 = 0,
|
|
75
74
|
TATSU = 1,
|
|
76
75
|
LURKR = 2,
|
|
76
|
+
AMARI = 3,
|
|
77
77
|
}
|
|
78
78
|
```
|
|
79
79
|
|
|
@@ -109,6 +109,16 @@ Lastly, you need to manually change `Choose the visibility for the web leaderboa
|
|
|
109
109
|
|
|
110
110
|
Nothing is required. -->
|
|
111
111
|
|
|
112
|
+
#### Amari
|
|
113
|
+
|
|
114
|
+
You need an API key, obtained by manually requesting it from Amari's Discord server at [this link](https://amaribot.com/support) and passed to the constructor via the `amari_api` parameter.
|
|
115
|
+
|
|
116
|
+
```ts
|
|
117
|
+
new Leveler({ guild: "...", amari_api: "123ABC..." });
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
> It's worth noting we tried to get it ourselves to test and were told that they're currently not issuing API keys as they're redoing the system or something like that.
|
|
121
|
+
|
|
112
122
|
## Credits and license
|
|
113
123
|
|
|
114
124
|
Originally made by [ZakaHaceCosas](https://zakahacecosas.github.io/) for the [Hokki](https://www.hokki.app) and [Sokora](https://sokora.org) Discord bots. Made open source under the MIT license for everyone to use, so long as our work is attributed (which'd make us really happy as reverse engineering some APIs was a true pain, to be fair).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hokkiai/djs-level-importer",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.2.0",
|
|
4
4
|
"description": "An open, JavaScript-based library to import leveling data from MEE6 and other bots. Made jointly by the Sokora and Hokki Discord bots.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"homepage": "https://github.com/hokkiai/djs-level-importer",
|