Skip to content

Commit 586fb15

Browse files
authored
Merge pull request #3 from tryforge/dev
v1.1.0
2 parents f45b448 + 1b53367 commit 586fb15

File tree

124 files changed

+1020
-353
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

124 files changed

+1020
-353
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div align="center">
22

3-
<img height="150" width="150" src="https://github.com/user-attachments/assets/9969c07b-2608-4ddd-930b-487485c07d80" alt="ForgeGiveaways">
3+
<img height="150" width="150" src="https://raw.githubusercontent.com/tryforge/ForgeGiveaways/main/assets/ForgeGiveaways.png" alt="ForgeGiveaways">
44

55
# ForgeGiveaways
66
ForgeGiveaways is a lightweight, flexible, and reliable extension for managing giveaways. Fully customizable features let you automate, track, and control every giveaway seamlessly.
@@ -22,7 +22,7 @@ ForgeGiveaways is a lightweight, flexible, and reliable extension for managing g
2222

2323
<h3 align="center">Installation</h3><hr>
2424

25-
> [!WARNING]
25+
> ⚠️ **Warning**\
2626
> **ForgeGiveaways** requires the extension [**ForgeDB**](https://docs.botforge.org/p/ForgeDB/) installed in order to operate.
2727
2828
1. Run the following command to install the required `npm` packages:
@@ -58,14 +58,14 @@ ForgeGiveaways is a lightweight, flexible, and reliable extension for managing g
5858
client.login("YourToken")
5959
```
6060
61-
> [!NOTE]
62-
> View all available client options [here](https://github.com/tryforge/ForgeGiveaways/blob/main/src/index.ts#L8).
61+
> ℹ️ **Note**\
62+
> View all available client options [here](https://tryforge.github.io/ForgeGiveaways/interfaces/IForgeGiveawaysOptions.html).
6363
6464
<h3 align="center">Custom Messages</h3><hr>
6565
6666
You can disable the default messages by setting `useDefault: false` in the client options, and override them with custom messages emitted through events. Use desired functions to retrieve information about the current giveaway.
6767
68-
> [!WARNING]
68+
> ⚠️ **Warning**\
6969
> Only **one** `giveawayStart` event is allowed per client instance!
7070
7171
#### Examples
@@ -83,7 +83,7 @@ module.exports = {
8383
$addTextDisplay[**Prize:** $giveawayPrize\n**Winners:** $giveawayWinnersCount]
8484
$addSeparator
8585
$addActionRow
86-
$addButton[giveawayEntry-$giveawayID;Join;Secondary;🎉]
86+
$addButton[giveawayEntry;Join;Secondary;🎉]
8787
;Green]
8888
;true]
8989
]
@@ -107,9 +107,9 @@ module.exports = {
107107
108108
The custom ID for giveaway entry buttons must follow this exact format:
109109
```
110-
giveawayEntry-GIVEAWAY_ID
110+
giveawayEntry
111111
```
112-
<sub>*Replace "GIVEAWAY_ID" with the actual ID of the giveaway. See the `giveawayStart` example above for reference.*</sub>
112+
<sub>*See the `giveawayStart` example above for reference.*</sub>
113113
114114
\
115115
Through the entry-related events, you can send custom responses directly to the current interaction context.

assets/ForgeGiveaways.png

98.5 KB
Loading

dist/events/giveawayEdit.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import { GiveawaysEventHandler } from "../handlers";
2+
declare const _default: GiveawaysEventHandler<"giveawayEdit">;
3+
export default _default;
4+
//# sourceMappingURL=giveawayEdit.d.ts.map

dist/events/giveawayEdit.d.ts.map

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/events/giveawayEdit.js

Lines changed: 30 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/events/giveawayEdit.js.map

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/events/giveawayEnd.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/events/giveawayEnd.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/events/giveawayEntryAdd.d.ts.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/events/giveawayEntryAdd.js

Lines changed: 5 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)