Skip to content

Commit adaf5d1

Browse files
committed
chore: update readme
1 parent 18f2b55 commit adaf5d1

1 file changed

Lines changed: 92 additions & 3 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 92 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,53 @@ console.log(entityManager.entities);
206206

207207
## πŸ’‘ Complete Examples
208208

209-
### Example 1: AFK Script
209+
### Quick Reference
210+
211+
Choose an example based on your experience level:
212+
213+
| Example | Difficulty | What You'll Learn | Install |
214+
| ------------------------------------------ | --------------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
215+
| [Press O Script](#beginner-press-o-script) | 🟒 Beginner | Basic events, auto-spawn | [![Install](https://img.shields.io/badge/Install-Press_O-44cc11?style=flat&logo=tampermonkey)](https://github.com/Cazka/diepAPI/raw/main/examples/press_o.user.js) |
216+
| [AFK Script](#beginner-afk-script) | 🟒 Beginner | Event handling, player control, movement | [![Install](https://img.shields.io/badge/Install-AFK_Script-44cc11?style=flat&logo=tampermonkey)](https://github.com/Cazka/diepAPI/raw/main/examples/afk.user.js) |
217+
| [Shape Farmer](#intermediate-shape-farmer) | 🟑 Intermediate | Entity tracking, filtering, targeting | [![Install](https://img.shields.io/badge/Install-Shape_Farmer-44cc11?style=flat&logo=tampermonkey)](https://github.com/Cazka/diepAPI/raw/main/examples/farmer.user.js) |
218+
219+
---
220+
221+
### Beginner Examples
222+
223+
#### Beginner: Press O Script
224+
225+
The simplest possible bot - automatically opens the upgrade menu when you spawn and respawns when you die.
226+
227+
[![Install Press O Script](https://img.shields.io/badge/Install-Press_O_Script-44cc11?style=flat&logo=tampermonkey)](https://github.com/Cazka/diepAPI/raw/main/examples/press_o.user.js)
228+
229+
```javascript
230+
// ==UserScript==
231+
// @name Press O
232+
// @description best script
233+
// @version 0.0.2
234+
// @author Cazka
235+
// @match https://diep.io/*
236+
// @require https://github.com/Cazka/diepAPI/releases/latest/download/diepAPI.user.js
237+
// @icon https://www.google.com/s2/favicons?domain=diep.io
238+
// @grant none
239+
// ==/UserScript==
240+
241+
const { player } = window.diepAPI.apis;
242+
243+
player.on('spawn', async () => await player.keyPress('o'));
244+
player.on('dead', async () => await player.spawn());
245+
```
246+
247+
**What you'll learn:**
248+
249+
- Using player events (`spawn`, `dead`)
250+
- Auto-spawning with `player.spawn()`
251+
- Simulating key presses with `player.keyPress()`
252+
253+
---
254+
255+
#### Beginner: AFK Script
210256

211257
Keep your tank stationary at its current position. Press Q to toggle AFK mode on/off.
212258

@@ -263,7 +309,9 @@ game.on('frame', () => {
263309

264310
---
265311

266-
### Example 2: Shape Farmer Script
312+
### Intermediate Examples
313+
314+
#### Intermediate: Shape Farmer
267315

268316
Automatically aims at nearby shapes and shoots them. Press P to toggle farming mode on/off.
269317

@@ -457,6 +505,46 @@ Contributions are welcome! Whether it's bug reports, feature requests, or code c
457505

458506
---
459507

508+
## πŸ‘₯ Community & Support
509+
510+
### Join Our Discord
511+
512+
[![Discord](https://img.shields.io/discord/298838657974927360?label=Discord&logo=discord&color=7289DA&style=for-the-badge)](https://discord.gg/5q2E3Sx)
513+
514+
Join our Discord community to:
515+
516+
- πŸ’¬ Get help and support from other developers
517+
- 🎨 Share your bots and scripts
518+
- πŸ’‘ Discuss new features and ideas
519+
- πŸ› Report bugs and get quick assistance
520+
- 🀝 Connect with the diepAPI community
521+
522+
### Community Projects
523+
524+
Showcase your amazing creations built with diepAPI! See what others have made and share your own.
525+
526+
| Project Name | Description | Author | Links |
527+
| -------------------- | -------------------------------------- | ----------- | ------------------------ |
528+
| _Your project here!_ | _Submit a PR to showcase your project_ | _Your name_ | _Link to your repo/gist_ |
529+
530+
**Want to showcase your project?** Submit a PR adding your project to this table! Make sure your project is educational or automation-focused (no cheats/exploits).
531+
532+
### Contributors
533+
534+
A huge thank you to everyone who has contributed to diepAPI! πŸŽ‰
535+
536+
- **View all contributors:** [GitHub Contributors](https://github.com/Cazka/diepAPI/graphs/contributors)
537+
- **Want to contribute?** Check out the [Contributing](#-contributing) section above
538+
539+
We appreciate:
540+
541+
- πŸ› Bug reports and fixes
542+
- ✨ New features and improvements
543+
- πŸ“š Documentation enhancements
544+
- πŸ’‘ Ideas and suggestions
545+
546+
---
547+
460548
## πŸ“„ License
461549

462550
diepAPI is licensed under the **MIT License**. See [LICENSE](LICENSE) for details.
@@ -466,7 +554,8 @@ diepAPI is licensed under the **MIT License**. See [LICENSE](LICENSE) for detail
466554
## πŸ”— Helpful Links
467555

468556
- **πŸ“˜ Full Documentation:** [https://cazka.github.io/diepAPI/](https://cazka.github.io/diepAPI/)
469-
- **πŸ’‘ More Examples:** [examples/](https://github.com/Cazka/diepAPI/tree/main/examples)
557+
- **πŸ’‘ Examples:** See [Complete Examples](#-complete-examples) (categorized by difficulty) or browse all in [examples/](https://github.com/Cazka/diepAPI/tree/main/examples)
558+
- **πŸ’¬ Discord Community:** [Join our Discord](https://discord.gg/5q2E3Sx) - Get help, share projects, and connect with developers
470559
- **πŸ› Report Issues:** [GitHub Issues](https://github.com/Cazka/diepAPI/issues)
471560
- **⭐ Star on GitHub:** [Cazka/diepAPI](https://github.com/Cazka/diepAPI)
472561

0 commit comments

Comments
Β (0)