Skip to content

Commit 01d3d03

Browse files
committed
Update docs.md
1 parent 67bd930 commit 01d3d03

File tree

1 file changed

+79
-63
lines changed

1 file changed

+79
-63
lines changed

docs.md

+79-63
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ For future reference in this documentation: when referring to 'alex_api' we refe
2323
All available endpoints you can use.
2424

2525
### await alex_api.achievement(text, icon = MinecraftIcons.RANDOM)
26-
Generate a Minecraft achievement with custom text.
26+
Generate a Minecraft achievement with custom text and icon.
2727

2828
**Parameters**:
2929
- text `string` | Text for the achievement.
@@ -33,10 +33,10 @@ Generate a Minecraft achievement with custom text.
3333

3434
---
3535
### await alex_api.amiajoke(image)
36-
Get an "am i a joke" picture with your image.
36+
Get an "am i a joke" picture with your avatar.
3737

3838
**Parameters**:
39-
- image `string` | URL of the image you want.
39+
- image `string` | URL of the avatar.
4040

4141
**Return type:** [Image](docs.md#image "Image object attributes")
4242

@@ -220,6 +220,15 @@ When someone is being salty.
220220

221221
**Return type:** [Image](docs.md#image "Image object attributes")
222222

223+
---
224+
### await alex_api.shame(image)
225+
Make that "Dock Of Shame" picture with your own image.
226+
227+
**Parameters**:
228+
- image `string` | The person's avatar.
229+
230+
**Return type:** [Image](docs.md#image "Image object attributes")
231+
223232
---
224233
### await alex_api.scroll(text)
225234
Make that scroll meme with your text.
@@ -348,6 +357,13 @@ async def supreme(ctx, text: str):
348357
file = discord.File(image_bytes, "supreme.png") # pass io.BytesIO object to discord.File with a filename.
349358
await ctx.send(embed=embed, file=file) # send both the embed and file, the file will attach to the embed.
350359

360+
# Or ----
361+
362+
# Oneline, because oneline = best
363+
embed = discord.Embed(title = f"Rendered by {ctx.author}").set_image(url="attachment://supreme.png")
364+
image = discord.File(await (await alex_api.supreme(text=text)).read(), "supreme.png")
365+
await ctx.send(embed=embed, file=image)
366+
351367
# have this where you close the bot or somewhere to close the session and prevent the "Unclosed client session" warning.
352368
await alex_api.close()
353369

@@ -405,7 +421,7 @@ The INT value of colour
405421
#### Colour.name
406422
The name of colour
407423

408-
#### Colour.rgb
424+
### Colour.rgb
409425
The RGB values of colour
410426

411427
#### Colour.rgb_values
@@ -435,184 +451,184 @@ The B values of the colour
435451
## MinecraftIcons
436452
Enum for [`.achievement()`](#await-alex_apiachievementtext-icon--minecrafticonsrandom) and [`.challenge()`](#await-alex_apichallengetext-icon--minecrafticonsrandom).
437453

438-
### 1 or grass_block (or grassblock)
454+
#### 1 or grass_block (or grassblock)
439455
Grass_Block icon for the achievement or challenge.
440456

441-
### 2 or diamond
457+
#### 2 or diamond
442458
Diamond icon for the achievement or challenge.
443459

444-
### 3 or diamond_sword (or diamondsword)
460+
#### 3 or diamond_sword (or diamondsword)
445461
Diamond_Sword icon for the achievement or challenge.
446462

447-
### 4 or creeper
463+
#### 4 or creeper
448464
Creeper icon for the achievement or challenge.
449465

450-
### 5 or pig
466+
#### 5 or pig
451467
Pig icon for the achievement or challenge.
452468

453-
### 6 or tnt
469+
#### 6 or tnt
454470
Tnt icon for the achievement or challenge.
455471

456-
### 7 or cookie
472+
#### 7 or cookie
457473
Cookie icon for the achievement or challenge.
458474

459-
### 8 or heart
475+
#### 8 or heart
460476
Heart icon for the achievement or challenge.
461477

462-
### 9 or bed
478+
#### 9 or bed
463479
Bed icon for the achievement or challenge.
464480

465-
### 10 or cake
481+
#### 10 or cake
466482
Cake icon for the achievement or challenge.
467483

468-
### 11 or sign
484+
#### 11 or sign
469485
Sign icon for the achievement or challenge.
470486

471-
### 12 or rail
487+
#### 12 or rail
472488
Rail icon for the achievement or challenge.
473489

474-
### 13 or crafting_bench (or craftingbench)
490+
#### 13 or crafting_bench (or craftingbench)
475491
Crafting_Bench icon for the achievement or challenge.
476492

477-
### 14 or redstone
493+
#### 14 or redstone
478494
Redstone icon for the achievement or challenge.
479495

480-
### 15 or fire
496+
#### 15 or fire
481497
Fire icon for the achievement or challenge.
482498

483-
### 16 or cobweb
499+
#### 16 or cobweb
484500
Cobweb icon for the achievement or challenge.
485501

486-
### 17 or chest
502+
#### 17 or chest
487503
Chest icon for the achievement or challenge.
488504

489-
### 18 or furnace
505+
#### 18 or furnace
490506
Furnace icon for the achievement or challenge.
491507

492-
### 19 or book
508+
#### 19 or book
493509
Book icon for the achievement or challenge.
494510

495-
### 20 or stone_block (or stoneblock)
511+
#### 20 or stone_block (or stoneblock)
496512
Stone_Block icon for the achievement or challenge.
497513

498-
### 21 or wooden_plank_block (or woodenplankblock)
514+
#### 21 or wooden_plank_block (or woodenplankblock)
499515
Wooden_Plank_Block icon for the achievement or challenge.
500516

501-
### 22 or iron_ingot (or ironingot)
517+
#### 22 or iron_ingot (or ironingot)
502518
Iron_Ingot icon for the achievement or challenge.
503519

504-
### 23 or gold_ingot (or goldingot)
520+
#### 23 or gold_ingot (or goldingot)
505521
Gold_Ingot icon for the achievement or challenge.
506522

507-
### 24 or wooden_door (or woodendoor)
523+
#### 24 or wooden_door (or woodendoor)
508524
Wooden_Door icon for the achievement or challenge.
509525

510-
### 25 or iron_door (or irondoor)
526+
#### 25 or iron_door (or irondoor)
511527
Iron_Door icon for the achievement or challenge.
512528

513-
### 26 or diamond_chestplate (or diamondchestplate)
529+
#### 26 or diamond_chestplate (or diamondchestplate)
514530
Diamond_Chestplate icon for the achievement or challenge.
515531

516-
### 27 or flint_and_steel (or flintandsteel)
532+
#### 27 or flint_and_steel (or flintandsteel)
517533
Flint_And_Steel icon for the achievement or challenge.
518534

519-
### 28 or glass_bottle (or glassbottle)
535+
#### 28 or glass_bottle (or glassbottle)
520536
Glass_Bottle icon for the achievement or challenge.
521537

522-
### 29 or splash_potion (or splashpotion)
538+
#### 29 or splash_potion (or splashpotion)
523539
Splash_Potion icon for the achievement or challenge.
524540

525-
### 30 or creeper_spawnegg (or creeperspawnegg)
541+
#### 30 or creeper_spawnegg (or creeperspawnegg)
526542
Creeper_Spawnegg icon for the achievement or challenge.
527543

528-
### 38 or creeperspawnegg
544+
#### 38 or creeperspawnegg
529545
Creeperspawnegg icon for the achievement or challenge.
530546

531-
### 31 or coal
547+
#### 31 or coal
532548
Coal icon for the achievement or challenge.
533549

534-
### 32 or iron_sword (or ironsword)
550+
#### 32 or iron_sword (or ironsword)
535551
Iron_Sword icon for the achievement or challenge.
536552

537-
### 33 or bow
553+
#### 33 or bow
538554
Bow icon for the achievement or challenge.
539555

540-
### 34 or arrow
556+
#### 34 or arrow
541557
Arrow icon for the achievement or challenge.
542558

543-
### 35 or iron_chestplate (or ironchestplate)
559+
#### 35 or iron_chestplate (or ironchestplate)
544560
Iron_Chestplate icon for the achievement or challenge.
545561

546-
### 36 or bucket
562+
#### 36 or bucket
547563
Bucket icon for the achievement or challenge.
548564

549-
### 37 or bucket_with_water (or bucketwithwater)
565+
#### 37 or bucket_with_water (or bucketwithwater)
550566
Bucket_With_Water icon for the achievement or challenge.
551567

552-
### 39 or bucket_with_milk (or bucketwithmilk)
568+
#### 39 or bucket_with_milk (or bucketwithmilk)
553569
Bucket_With_Milk icon for the achievement or challenge.
554570

555-
### 40 or diamond_boots (or diamondboots)
571+
#### 40 or diamond_boots (or diamondboots)
556572
Diamond_Boots icon for the achievement or challenge.
557573

558-
### 41 or wooden_hoe (or woodenhoe)
574+
#### 41 or wooden_hoe (or woodenhoe)
559575
Wooden_Hoe icon for the achievement or challenge.
560576

561-
### 42 or bread
577+
#### 42 or bread
562578
Bread icon for the achievement or challenge.
563579

564-
### 43 or wooden_sword (or woodensword)
580+
#### 43 or wooden_sword (or woodensword)
565581
Wooden_Sword icon for the achievement or challenge.
566582

567-
### 44 or bone
583+
#### 44 or bone
568584
Bone icon for the achievement or challenge.
569585

570-
### 45 or oak_log (or oaklog)
586+
#### 45 or oak_log (or oaklog)
571587
Oak_Log icon for the achievement or challenge.
572588

573-
### 46 or random
589+
#### 46 or random
574590
Random icon from above for the achievement or challenge.
575591

576592

577593
## Filters
578594
Enum for [`.filter()`](#await-alex_apifiltername-image).
579595

580-
### 1 or blur
596+
#### 1 or blur
581597
Blur filter.
582598

583-
### 2 or invert
599+
#### 2 or invert
584600
Invert filter.
585601

586-
### 3 or b&w or black_and_white
602+
#### 3 or b&w or black_and_white
587603
Black and White filter.
588604

589-
### 4 or deepfry
605+
#### 4 or deepfry
590606
Deepfry filter.
591607

592-
### 5 or sepia
608+
#### 5 or sepia
593609
Sepia filter.
594610

595-
### 6 or pixelate
611+
#### 6 or pixelate
596612
Pixelate filter.
597613

598-
### 7 or magik
614+
#### 7 or magik
599615
Magik filter.
600616

601-
### 8 or jpegify
617+
#### 8 or jpegify
602618
Jpegify filter.
603619

604-
### 9 or wide
620+
#### 9 or wide
605621
Wide filter.
606622

607-
### 10 or snow
623+
#### 10 or snow
608624
Snow filter.
609625

610-
### 11 or gay
626+
#### 11 or gay
611627
Gay filter.
612628

613-
### 12 or communist
629+
#### 12 or communist
614630
Communist filter.
615631

616-
### 13 or random
632+
#### 13 or random
617633
Random filter from above.
618634

0 commit comments

Comments
 (0)